001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common Development
008: * and Distribution License("CDDL") (collectively, the "License"). You
009: * may not use this file except in compliance with the License. You can obtain
010: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
011: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
012: * language governing permissions and limitations under the License.
013: *
014: * When distributing the software, include this License Header Notice in each
015: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
016: * Sun designates this particular file as subject to the "Classpath" exception
017: * as provided by Sun in the GPL Version 2 section of the License file that
018: * accompanied this code. If applicable, add the following below the License
019: * Header, with the fields enclosed by brackets [] replaced by your own
020: * identifying information: "Portions Copyrighted [year]
021: * [name of copyright owner]"
022: *
023: * Contributor(s):
024: *
025: * If you wish your version of this file to be governed by only the CDDL or
026: * only the GPL Version 2, indicate your decision by adding "[Contributor]
027: * elects to include this software in this distribution under the [CDDL or GPL
028: * Version 2] license." If you don't indicate a single choice of license, a
029: * recipient has the option to distribute your version of this file under
030: * either the CDDL, the GPL Version 2 or to extend the choice of license to
031: * its licensees as provided above. However, if you add GPL Version 2 code
032: * and therefore, elected the GPL Version 2 license, then the option applies
033: * only if the new code is made subject to such option by the copyright
034: * holder.
035: */
036:
037: package com.sun.xml.ws.runtime.util;
038:
039: import java.util.Set;
040: import com.sun.xml.ws.util.ServiceFinder;
041:
042: /**
043: *
044: * The <code>SessionManager</code> is used to obtain session information
045: * This can be implemented using persisitent storage mechanisms or using transient storage
046: * Even if it is implemented using persistent storage the implementation should take care
047: * of backing by a cache which will avoid the overhead of serialization and database
048: * operations
049: * <p>
050: * Additonally the <code>SessionManager</code> is responsible for managing the lifecycle
051: * events for the sessions. It exposes methods to create and terminate the session
052: * Periodically the <code>SessionManager</code> will check for sessions who have been inactive for
053: * a predefined amount of time and then will terminate those sessions
054: *
055: * @author Bhakti Mehta
056: * @author Mike Grogan
057: */
058:
059: public abstract class SessionManager {
060:
061: private static SessionManager manager;
062:
063: /**
064: * Returns an existing session identified by the Key else null
065: *
066: * @param key The Session key.
067: * @returns The Session with the given key. <code>null</code> if none exists.
068: */
069: public abstract Session getSession(String key);
070:
071: /**
072: * Returns the Set of valid Session keys.
073: *
074: * @returns The Set of keys.
075: */
076: public abstract Set<String> getKeys();
077:
078: /**
079: * Removed the Session with the given key.
080: *
081: * @param key The key of the Session to be removed.
082: */
083: public abstract void terminateSession(String key);
084:
085: /**
086: * Creates a Session with the given key, using a new instance
087: * of the specified Class as a holder for user-defined data. The
088: * specified Class must have a default ctor.
089: *
090: * @param key The Session key to be used.
091: * @returns The new Session.. <code>null</code> if the given
092: * class cannot be instantiated.
093: *
094: */
095: public abstract Session createSession(String key, Class clasz);
096:
097: /**
098: * Creates a Session with the given key, using the specified Object
099: * as a holder for user-defined data.
100: *
101: * @param key The Session key to be used.
102: * @param obj The object to use as a holder for user data in the session.
103: * @returns The new Session.
104: *
105: */
106: public abstract Session createSession(String key, Object obj);
107:
108: /**
109: * Creates a Session with the given key, using an instance of
110: * java.util.Hashtable<String, String> asa holder for user-defined data.
111: *
112: * @param key The Session key to be used.
113: * @returns The new Session.
114: *
115: */
116: public abstract Session createSession(String key);
117:
118: /**
119: * Saves the state of the Session with the given key.
120: *
121: * @param key The key of the session to be saved
122: */
123: public abstract void saveSession(String key);
124:
125: /**
126: * Returns the single instance of SessionManager
127: * Use the usual services mechanism to find implementing class. If not
128: * found, use <code>com.sun.xml.ws.runtime.util.SessionManager</code>
129: * by default.
130: *
131: * @return The value of the <code>manager</code> field.
132: */
133: public static SessionManager getSessionManager() {
134: synchronized (SessionManager.class) {
135: if (manager == null) {
136: ServiceFinder<SessionManager> finder = ServiceFinder
137: .find(SessionManager.class);
138: if (finder != null && finder.toArray().length > 0) {
139: manager = finder.toArray()[0];
140: } else {
141: manager = new SessionManagerImpl();
142: }
143: }
144: return manager;
145: }
146: }
147:
148: }
|