com.sun.xml.ws.runtime.dev.SessionManager Maven / Gradle / Ivy
Show all versions of webservices-rt Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.xml.ws.runtime.dev;
import com.sun.istack.logging.Logger;
import com.sun.xml.ws.api.server.WSEndpoint;
import com.sun.xml.ws.commons.AbstractMOMRegistrationAware;
import com.sun.xml.ws.commons.WSEndpointCollectionBasedMOMListener;
import com.sun.xml.ws.commons.MOMRegistrationAware;
import com.sun.xml.ws.security.IssuedTokenContext;
import com.sun.xml.ws.security.SecurityContextTokenInfo;
import com.sun.xml.ws.util.ServiceFinder;
import org.glassfish.gmbal.AMXMetadata;
import org.glassfish.gmbal.Description;
import org.glassfish.gmbal.ManagedAttribute;
import org.glassfish.gmbal.ManagedObject;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
/**
*
* The SessionManager is used to obtain session information
* This can be implemented using persistent storage mechanisms or using transient storage
* Even if it is implemented using persistent storage the implementation should take care
* of backing by a cache which will avoid the overhead of serialization and database
* operations
*
* Additionally the SessionManager is responsible for managing the life cycle
* events for the sessions. It exposes methods to create and terminate the session
* Periodically the SessionManager will check for sessions who have been inactive for
* a predefined amount of time and then will terminate those sessions
*
* @author Bhakti Mehta
* @author Mike Grogan
*/
@ManagedObject
@Description("Session manager used by RM and SC")
@AMXMetadata(type="WSRMSCSessionManager")
public abstract class SessionManager extends AbstractMOMRegistrationAware {
private static final Logger LOGGER = Logger.getLogger(SessionManager.class);
private static Properties config = null;
private static final Object LOCK = new Object();
private static final Map SESSION_MANAGERS = new HashMap();
private static final WSEndpointCollectionBasedMOMListener listener;
public static final String TIMEOUT_INTERVAL = "session-timeout";
public static final String SESSION_THRESHOLD = "session-threshold";
static {
listener = new WSEndpointCollectionBasedMOMListener(LOCK, "RM_SC_SessionManager", SESSION_MANAGERS);
listener.initialize();
}
/**
* @return the config
*/
public static Properties getConfig() {
return config;
}
/**
* @param aConfig the config to set
*/
public static void setConfig(Properties aConfig) {
config = aConfig;
}
/**
* Returns an existing session identified by the Key else null
*
* @param key The Session key.
* @returns The Session with the given key. null if none exists.
*/
public abstract Session getSession(String key) ;
/**
* Returns the Set of valid Session keys.
*
* @returns The Set of keys.
*/
@ManagedAttribute
@Description("The set of valid Session keys")
public abstract Set keys();
/**
* @returns The Collection of valid Sessions.
*/
@ManagedAttribute
@Description("The collection of valid Sessions")
protected abstract Collection sessions();
/**
* Removed the Session with the given key.
*
* @param key The key of the Session to be removed.
*/
public abstract void terminateSession(String key);
/**
* Creates a Session with the given key, using a new instance
* of the specified Class as a holder for user-defined data. The
* specified Class must have a default ctor.
*
* @param key The Session key to be used.
* @returns The new Session.. null if the given
* class cannot be instantiated.
*
*/
public abstract Session createSession(String key, Class clasz);
/**
* Creates a Session with the given key, using the specified Object
* as a holder for user-defined data.
*
* @param key The Session key to be used.
* @param obj The object to use as a holder for user data in the session.
* @returns The new Session.
*
*/
public abstract Session createSession(String key, Object obj);
public abstract Session createSession(String key, SecurityContextTokenInfo sctInfo);
/**
* Creates a Session with the given key, using an instance of
* java.util.Hashtable asa holder for user-defined data.
*
* @param key The Session key to be used.
* @returns The new Session.
*
*/
public abstract Session createSession(String key);
/**
* Saves the state of the Session with the given key.
*
* @param key The key of the session to be saved
*/
public abstract void saveSession(String key);
/**
* Return the valid SecurityContext for matching key
*
* @param key The key of the security context to be looked
* @param expiryCheck indicates whether to check the token expiry or not,
* As in case of renew we don't need to check token expiry
* @returns IssuedTokenContext for security context key
*/
public abstract IssuedTokenContext getSecurityContext(String key, boolean checkExpiry);
/**
* Add the SecurityContext with key in local cache
*
* @param key The key of the security context to be stored
* @param itctx The IssuedTokenContext to be stored
*/
public abstract void addSecurityContext(String key, IssuedTokenContext itctx);
public static void removeSessionManager(WSEndpoint endpoint){
synchronized (LOCK) {
try {
LOGGER.entering();
Object o = SESSION_MANAGERS.remove(endpoint);
LOGGER.config(String.format("removeSessionManager(%s): %s",
endpoint, o));
SessionManager sessionManager = (SessionManager) o;
if (sessionManager != null && sessionManager.isRegisteredAtMOM()) {
listener.unregisterFromMOM(sessionManager, endpoint);
}
} finally {
LOGGER.exiting();
}
}
}
/**
* Returns the single instance of SessionManager
* Use the usual services mechanism to find implementing class. If not
* found, use com.sun.xml.ws.runtime.util.SessionManager
* by default.
*
* @return The value of the manager field.
*/
public static SessionManager getSessionManager(WSEndpoint endpoint, boolean isSC, Properties props) {
synchronized (LOCK) {
try {
LOGGER.entering();
SessionManager sm = SESSION_MANAGERS.get(endpoint);
if (sm == null) {
ServiceFinder finder =
ServiceFinder.find(SessionManager.class);
if (finder != null && finder.toArray().length > 0) {
sm = finder.toArray()[0];
} else {
sm = new SessionManagerImpl(endpoint, isSC, props);
}
SESSION_MANAGERS.put(endpoint, sm);
if (listener.canRegisterAtMOM()) {
listener.registerAtMOM(sm, endpoint);
}
LOGGER.config(String.format("getSessionManager(%s): created: %s", endpoint, sm));
} else {
LOGGER.config(String.format("getSessionManager(%s): found existing: %s", endpoint, sm));
}
return sm;
} finally {
LOGGER.exiting();
}
}
}
public static SessionManager getSessionManager(WSEndpoint endpoint, Properties props){
return getSessionManager(endpoint, false, props);
}
}