001: /*
002: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/Store.java,v 1.4 2001/07/22 20:13:30 pier Exp $
003: * $Revision: 1.4 $
004: * $Date: 2001/07/22 20:13:30 $
005: *
006: * ====================================================================
007: *
008: * The Apache Software License, Version 1.1
009: *
010: * Copyright (c) 1999 The Apache Software Foundation. All rights
011: * reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions
015: * are met:
016: *
017: * 1. Redistributions of source code must retain the above copyright
018: * notice, this list of conditions and the following disclaimer.
019: *
020: * 2. Redistributions in binary form must reproduce the above copyright
021: * notice, this list of conditions and the following disclaimer in
022: * the documentation and/or other materials provided with the
023: * distribution.
024: *
025: * 3. The end-user documentation included with the redistribution, if
026: * any, must include the following acknowlegement:
027: * "This product includes software developed by the
028: * Apache Software Foundation (http://www.apache.org/)."
029: * Alternately, this acknowlegement may appear in the software itself,
030: * if and wherever such third-party acknowlegements normally appear.
031: *
032: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
033: * Foundation" must not be used to endorse or promote products derived
034: * from this software without prior written permission. For written
035: * permission, please contact apache@apache.org.
036: *
037: * 5. Products derived from this software may not be called "Apache"
038: * nor may "Apache" appear in their names without prior written
039: * permission of the Apache Group.
040: *
041: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
042: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
043: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
044: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
045: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
046: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
047: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
048: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
049: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
050: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
051: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
052: * SUCH DAMAGE.
053: * ====================================================================
054: *
055: * This software consists of voluntary contributions made by many
056: * individuals on behalf of the Apache Software Foundation. For more
057: * information on the Apache Software Foundation, please see
058: * <http://www.apache.org/>.
059: *
060: * [Additional notices, if required by prior licensing conditions]
061: *
062: */
063:
064: package org.apache.catalina;
065:
066: import java.beans.PropertyChangeListener;
067: import java.io.IOException;
068:
069: /**
070: * A <b>Store</b> is the abstraction of a Catalina component that provides
071: * persistent storage and loading of Sessions and their associated user data.
072: * Implementations are free to save and load the Sessions to any media they
073: * wish, but it is assumed that saved Sessions are persistent across
074: * server or context restarts.
075: *
076: * @author Craig R. McClanahan
077: * @version $Revision: 1.4 $ $Date: 2001/07/22 20:13:30 $
078: */
079:
080: public interface Store {
081:
082: // ------------------------------------------------------------- Properties
083:
084: /**
085: * Return descriptive information about this Store implementation and
086: * the corresponding version number, in the format
087: * <code><description>/<version></code>.
088: */
089: public String getInfo();
090:
091: /**
092: * Return the Manager instance associated with this Store.
093: */
094: public Manager getManager();
095:
096: /**
097: * Set the Manager associated with this Store.
098: *
099: * @param manager The Manager which will use this Store.
100: */
101: public void setManager(Manager manager);
102:
103: /**
104: * Return the number of Sessions present in this Store.
105: *
106: * @exception IOException if an input/output error occurs
107: */
108: public int getSize() throws IOException;
109:
110: // --------------------------------------------------------- Public Methods
111:
112: /**
113: * Add a property change listener to this component.
114: *
115: * @param listener The listener to add
116: */
117: public void addPropertyChangeListener(
118: PropertyChangeListener listener);
119:
120: /**
121: * Return an array containing the session identifiers of all Sessions
122: * currently saved in this Store. If there are no such Sessions, a
123: * zero-length array is returned.
124: *
125: * @exception IOException if an input/output error occurred
126: */
127: public String[] keys() throws IOException;
128:
129: /**
130: * Load and return the Session associated with the specified session
131: * identifier from this Store, without removing it. If there is no
132: * such stored Session, return <code>null</code>.
133: *
134: * @param id Session identifier of the session to load
135: *
136: * @exception ClassNotFoundException if a deserialization error occurs
137: * @exception IOException if an input/output error occurs
138: */
139: public Session load(String id) throws ClassNotFoundException,
140: IOException;
141:
142: /**
143: * Remove the Session with the specified session identifier from
144: * this Store, if present. If no such Session is present, this method
145: * takes no action.
146: *
147: * @param id Session identifier of the Session to be removed
148: *
149: * @exception IOException if an input/output error occurs
150: */
151: public void remove(String id) throws IOException;
152:
153: /**
154: * Remove all Sessions from this Store.
155: */
156: public void clear() throws IOException;
157:
158: /**
159: * Remove a property change listener from this component.
160: *
161: * @param listener The listener to remove
162: */
163: public void removePropertyChangeListener(
164: PropertyChangeListener listener);
165:
166: /**
167: * Save the specified Session into this Store. Any previously saved
168: * information for the associated session identifier is replaced.
169: *
170: * @param session Session to be saved
171: *
172: * @exception IOException if an input/output error occurs
173: */
174: public void save(Session session) throws IOException;
175:
176: }
|