*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.session
Class SessionServiceProxy

com.sas.services.session.SessionServiceProxy

All Implemented Interfaces:

com.sas.entities.EntityKeyInterface, ServiceNotificationBroadcasterInterface, QuiesceInterface, RemoteServiceInterface, SessionServiceInterface, java.io.Serializable, java.rmi.Remote

@SASScope(value="ALL")
@BinaryCompatibilityOnly
public class SessionServiceProxy
implements SessionServiceInterface, java.io.Serializable

Session Service proxy. If this proxy is serialized to a remote process then the proxy will optimize calls to ensure that a local object reference is used where appropriate and that static data is cached locally to minimize remote calls.

Since:

1.1

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.sas.services.RemoteServiceInterface

CLASS_IDENTIFIER, CLASS_IDENTIFIER_1_1, CLASS_IDENTIFIER_1_2, CLASS_IDENTIFIER_SERVICE_TYPE, CLASS_IDENTIFIER_SERVICE_TYPE_1_1, CLASS_IDENTIFIER_SERVICE_TYPE_1_2

Constructor Summary

SessionServiceProxy(SessionServiceInterface sessionService)
Constructs a proxy to the specified session service.

Method Summary

boolean	destroySession(UserContextInterface userContext, java.lang.String sessionContextId) Forcibly destroys the session context identified by the session context id.
void	destroySessions(UserContextInterface userContext) This destroys all session contexts created by this session service, without destroying the session service itself.
SessionContextInterface	fromByteArray(byte[] data) Instantiate a SessionContext from a passivated byte array.
SessionContextInterface	getSessionContext(java.lang.String uniqueId) Obtains the session context interface identified by the unique identifer or null if no session context exists with this id.
SessionContextInterface	getSessionContext(UserContextInterface userContext, java.lang.String uniqueId) Obtains the session context interface identified by the unique identifer or null if no session context exists with this id.
java.util.List	getSummaryData(UserContextInterface userContext) Return summary information for all active session contexts created by this Session Service.
boolean	isQuiesced() Returns a flag indicating whether the Session Service is in a quiesce state or not.
SessionContextInterface	newSessionContext(UserContextInterface userContext) Creates and returns a new session context interface.
void	quiesce(UserContextInterface userContext) Resumes the session service.
void	resume(UserContextInterface userContext) Resume the session service.

Methods inherited from class com.sas.services.ServiceProxy

addServiceObserver, configure, destroy, findRemoteService, getCreationTime, getEntityKey, getService, getServiceConfiguration, getServiceConfiguration, getServiceProxy, getServiceState, isAccessibleToRemoteClients, isExported, isLocalService, isProxyToRemoteService, notifyServiceObservers, reconfigure, removeAllServiceObservers, removeServiceObserver, sameEnitityKey, sameEntity, setEntityKey, setServiceState

Methods inherited from interface com.sas.services.RemoteServiceInterface

configure, destroy, getCreationTime, getServiceConfiguration, getServiceConfiguration, getServiceProxy, getServiceState, isAccessibleToRemoteClients, isExported, reconfigure, setServiceState

Methods inherited from interface com.sas.entities.EntityKeyInterface

getEntityKey, sameEntity, setEntityKey

Methods inherited from interface com.sas.services.mgmt.ServiceNotificationBroadcasterInterface

addServiceObserver, notifyServiceObservers, removeAllServiceObservers, removeServiceObserver

Constructor Detail

SessionServiceProxy

public SessionServiceProxy(SessionServiceInterface sessionService)
                    throws InitializationException

Constructs a proxy to the specified session service.

Parameters:

sessionService - Session service to be proxied.

Throws:

InitializationException - if unable to create a proxy for the logging service.

Method Detail

newSessionContext

public final SessionContextInterface newSessionContext(UserContextInterface userContext)
                                                throws InitializationException,
                                                       java.rmi.RemoteException

Creates and returns a new session context interface. The user context to bind to the session context can be provided. If a null user context is provided, it can be set at a later time. Once the user context has been set to a non-null value, it cannot be changed.

Specified by:

newSessionContext in interface SessionServiceInterface

Parameters:

userContext - User context for this session context; can be null.

Returns:

SessionContextInterface The created session context interface.

Throws:

InitializationException - If the context fails to initialize.

java.rmi.RemoteException - If a network anomaly is encountered.

getSessionContext

public final SessionContextInterface getSessionContext(java.lang.String uniqueId)
                                                throws java.rmi.RemoteException

Obtains the session context interface identified by the unique identifer or null if no session context exists with this id. The unique identifier is required to identify the desired context so that applications don't have access to all session contexts.

Specified by:

getSessionContext in interface SessionServiceInterface

Parameters:

uniqueId - Unique identifier of the session context to be returned.

Returns:

SessionContextInterface The session context interface.

Throws:

java.rmi.RemoteException - If a network anomaly is encountered.

getSessionContext

public final SessionContextInterface getSessionContext(UserContextInterface userContext,
                                                       java.lang.String uniqueId)
                                                throws java.rmi.RemoteException

Obtains the session context interface identified by the unique identifer or null if no session context exists with this id. The unique identifier is required to identify the desired context so that applications don't have access to all session contexts. This method is protected using JAAS permissions. A SessionContextPermission is required to obtain the session context from the Session Service.

Specified by:

getSessionContext in interface SessionServiceInterface

Parameters:

userContext - A user context whose principals will be checked for permission to perform the getSessionContext function. This can be null, but if the method is invoked remotely, it will always fail with a null user context.

uniqueId - Unique identifier of the session context to be returned.

Returns:

SessionContextInterface The session context interface.

Throws:

java.rmi.RemoteException - If a network anomaly is encountered.

quiesce

public final void quiesce(UserContextInterface userContext)
                   throws ServiceException,
                          QuiesceException,
                          java.rmi.RemoteException

Resumes the session service. This allows it to start creating new session contexts.

Specified by:

quiesce in interface QuiesceInterface

Specified by:

quiesce in interface SessionServiceInterface

Parameters:

userContext - The user context.

Throws:

ServiceException - If a service error occurs.

QuiesceException - If an error occurs quiescing the service.

java.rmi.RemoteException - If a network anomaly is encountered.

isQuiesced

public boolean isQuiesced()
                   throws java.rmi.RemoteException

Returns a flag indicating whether the Session Service is in a quiesce state or not.

Specified by:

isQuiesced in interface SessionServiceInterface

Returns:

true if the Session Service is in a quiesce state; otherwise false is returned.

Throws:

java.rmi.RemoteException - if a network error occurs.

resume

public final void resume(UserContextInterface userContext)
                  throws ServiceException,
                         QuiesceException,
                         java.rmi.RemoteException

Resume the session service. This should be called after the Session Service has been quiesced, to allow the Session Service to start creating new session contexts.

Specified by:

resume in interface QuiesceInterface

Specified by:

resume in interface SessionServiceInterface

Parameters:

userContext - The user context.

Throws:

ServiceException - If a service error occurs.

QuiesceException - If an error occurs quiescing the service.

java.rmi.RemoteException - If a network anomaly is encountered.

destroySessions

public void destroySessions(UserContextInterface userContext)
                     throws java.rmi.RemoteException

This destroys all session contexts created by this session service, without destroying the session service itself.

When each session context is destroyed, all objects are unbound from it. If the bound objects implement RemoteSessionContextStateChangedListener, the session context will invoke RemoteSessionContextStateChangedListener.contextStateChanged(SessionContextStateChangedEvent). This allows objects to be notified when they are removed from the session context so they can perform any necessary cleanup.

Specified by:

destroySessions in interface SessionServiceInterface

Parameters:

userContext - the user context.

Throws:

java.rmi.RemoteException - If a network anomaly is encountered.

destroySession

public boolean destroySession(UserContextInterface userContext,
                              java.lang.String sessionContextId)
                       throws java.rmi.RemoteException

Forcibly destroys the session context identified by the session context id. The session context will be destroyed even if is locked.

This method is protected using JAAS permissions. A SessionPermission is required to destroy the active session context.

Specified by:

destroySession in interface SessionServiceInterface

Parameters:

userContext - The user context.

sessionContextId - The unique identifier of the session context to destroy.

Returns:

boolean that is false if the session context identified by the unique id could not be found; otherwise true is returned.

Throws:

java.rmi.RemoteException - If a network anomaly is encountered.

getSummaryData

public java.util.List getSummaryData(UserContextInterface userContext)
                              throws java.rmi.RemoteException

Return summary information for all active session contexts created by this Session Service. Each session context can be bound to a user context. The summary data for each active session contains information such as the user context name, the user's email addresses, and the user's global profile.

Specified by:

getSummaryData in interface SessionServiceInterface

Parameters:

userContext - The user context.

Returns:

ListA list of SummaryDataInterface objects.

Throws:

java.rmi.RemoteException - if a network error occurs

fromByteArray

public SessionContextInterface fromByteArray(byte[] data)
                                      throws java.rmi.RemoteException,
                                             ServiceException

Description copied from interface: SessionServiceInterface

Instantiate a SessionContext from a passivated byte array. The first item in the passivated stream is the session ID. If that session ID is one this session service has in its known list, get it and return it.

Specified by:

fromByteArray in interface SessionServiceInterface

Parameters:

data - The passivated data stream.

Returns:

The instantiated Session Context

Throws:

java.rmi.RemoteException - In the event of remote object failure.

ServiceException - If an error occurs processing the data.

*** This class provides Binary Compatibility only, not Source Compatibility ***