I_CmsSession


1   /*
2   * File   : $Source: /usr/local/cvs/opencms/src-modules/com/opencms/core/I_CmsSession.java,v $
3   * Date   : $Date: 2005/05/17 13:47:28 $
4   * Version: $Revision: 1.1 $
5   *
6   * This library is part of OpenCms -
7   * the Open Source Content Mananagement System
8   *
9   * Copyright (C) 2001  The OpenCms Group
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * For further information about OpenCms, please see the
22  * OpenCms Website: http://www.opencms.org 
23  *
24  * You should have received a copy of the GNU Lesser General Public
25  * License along with this library; if not, write to the Free Software
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28  
29  package com.opencms.core;
30  
31  /**
32   * This interface defines an OpenCms session, a generic session object 
33   * that is used by OpenCms and provides methods to access the current users
34   * session data.<p>
35   * 
36   * @author Michael Emmerich
37   * @version $Revision: 1.1 $ $Date: 2005/05/17 13:47:28 $  
38   * 
39   * @deprecated Will not be supported past the OpenCms 6 release.
40   */
41  public interface I_CmsSession {
42      
43      /**
44       * Returns a value from the session.<p>
45       * 
46       * @param key the key
47       * @return the object the is mapped to this key
48       */
49      Object   getValue(String   key);
50      
51      /**
52       * Stores a value in the session.<p>
53       * 
54       * @param key the key to map the value to
55       * @param value an object to store for the key
56       */
57      void putValue(String   key, Object   value);
58      
59      /**
60       * Removes a value from the session.<p>
61       * 
62       * @param key the key for the value to remove
63       */
64      void removeValue(String   key);    
65      
66      /**
67       * Returns the session id.<p>
68       * 
69       * @return the session id
70       */
71      String   getId();
72      
73      /**
74       * Invalidates the session.
75       */
76      void invalidate();
77  }
78
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags