01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/util/tags/sakai_2-4-1/util-api/api/src/java/org/sakaiproject/thread_local/api/ThreadLocalManager.java $
03: * $Id: ThreadLocalManager.java 6832 2006-03-21 20:43:34Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.thread_local.api;
21:
22: /**
23: * <p>
24: * ThreadLocalManager provides registration and discovery of objects bound to the "current" request processing or thread.
25: * </p>
26: * <p>
27: * Clients who have objects to bind can set/get them at will - the Sakai Framework assures that the entire set of objects bound to current are cleared when the request processing is complete.
28: * </p>
29: */
30: public interface ThreadLocalManager {
31: /**
32: * Bind this object under this name with the current thread, or remove if the value is null.
33: *
34: * @param name
35: * The binding name.
36: * @param value
37: * The object to bind, or null to un-bind this name.
38: */
39: void set(String name, Object value);
40:
41: /**
42: * Remove all objects bound to the current thread.
43: */
44: void clear();
45:
46: /**
47: * Find the named object bound to the current thread.
48: *
49: * @param name
50: * The binding name.
51: * @return The object bound by this name, or null if not found.
52: */
53: Object get(String name);
54: }
|