KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > axis > session > Session


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2003 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Axis" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation. For more
52  * information on the Apache Software Foundation, please see
53  * <http://www.apache.org/>.
54  */
55
56 package org.jboss.axis.session;
57
58 import java.util.Enumeration JavaDoc;
59
60 /**
61  * An abstract interface to provide session storage to Axis services.
62  * <p/>
63  * This is extremely basic at the moment.
64  *
65  * @author Glen Daniels (gdaniels@macromedia.com)
66  */
67 public interface Session
68 {
69    /**
70     * Get a property from the session
71     *
72     * @param key the name of the property desired.
73     */
74    public Object JavaDoc get(String JavaDoc key);
75
76    /**
77     * Set a property in the session
78     *
79     * @param key the name of the property to set.
80     * @param value the value of the property.
81     */
82    public void set(String JavaDoc key, Object JavaDoc value);
83
84    /**
85     * Remove a property from the session
86     *
87     * @param key the name of the property desired.
88     */
89    public void remove(String JavaDoc key);
90
91    /**
92     * Get an enumeration of the keys in this session
93     */
94    public Enumeration JavaDoc getKeys();
95
96    /**
97     * Set the session's time-to-live.
98     * <p/>
99     * This is implementation-specific, but basically should be the #
100     * of seconds of inactivity which will cause the session to time
101     * out and invalidate. "inactivity" is implementation-specific.
102     */
103    public void setTimeout(int timeout);
104
105    /**
106     * Return the sessions' time-to-live.
107     *
108     * @return the timeout value for this session.
109     */
110    public int getTimeout();
111
112    /**
113     * "Touch" the session (mark it recently used)
114     */
115    public void touch();
116
117    /**
118     * Get an Object suitable for synchronizing the session. This method
119     * exists because different session implementations might provide
120     * different ways of getting at shared data. For a simple hashtable-
121     * based session, this would just be the hashtable, but for sessions
122     * which use database connections, etc. it might be an object wrapping
123     * a table ID or somesuch.
124     */
125    public Object JavaDoc getLockObject();
126 }
127
Popular Tags