01: // Copyright 2004, 2005 The Apache Software Foundation
02: //
03: // Licensed under the Apache License, Version 2.0 (the "License");
04: // you may not use this file except in compliance with the License.
05: // You may obtain a copy of the License at
06: //
07: // http://www.apache.org/licenses/LICENSE-2.0
08: //
09: // Unless required by applicable law or agreed to in writing, software
10: // distributed under the License is distributed on an "AS IS" BASIS,
11: // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12: // See the License for the specific language governing permissions and
13: // limitations under the License.
14:
15: package org.apache.hivemind.service;
16:
17: /**
18: * Provides a service which can temporarily store
19: * thread-local data. This is useful in a multithreaded
20: * environment, such as a servlet or Tapestry application.
21: * ThreadLocalStorage acts like a map around thread local data.
22: *
23: * @author Howard Lewis Ship
24: */
25: public interface ThreadLocalStorage {
26: /**
27: * Returns the thread-local object for the given key, or null
28: * if no such object exists.
29: */
30: public Object get(String key);
31:
32: /**
33: * Stores the value object at the given key, overwriting
34: * any prior value that may have been stored at that key.
35: * Care should be taken in selecting keys to avoid
36: * naming conflicts; in general, prefixing a key with
37: * a module id is a good idea.
38: */
39: public void put(String key, Object value);
40:
41: /**
42: * Clears all keys.
43: */
44: public void clear();
45: }
|