ThreadLocalStorage


1   // Copyright 2004, 2005 The Apache Software Foundation
2   //
3   // Licensed under the Apache License, Version 2.0 (the "License");
4   // you may not use this file except in compliance with the License.
5   // You may obtain a copy of the License at
6   //
7   //     http://www.apache.org/licenses/LICENSE-2.0
8   //
9   // 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      /**
28       * Returns the thread-local object for the given key, or null
29       * if no such object exists. 
30       */
31      public Object   get(String   key);
32      
33      /**
34       * Stores the value object at the given key, overwriting
35       * any prior value that may have been stored at that key.
36       * Care should be taken in selecting keys to avoid
37       * naming conflicts; in general, prefixing a key with
38       * a module id is a good idea.
39       */
40      public void put(String   key, Object   value);
41      
42      /**
43       * Clears all keys.
44       */
45      public void clear();
46  }
47

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags