com.iplanet.dpro.session.operations.strategies

Class ClientSdkOperations

java.lang.Object

com.iplanet.dpro.session.operations.strategies.ClientSdkOperations

All Implemented Interfaces:

SessionOperations

public class ClientSdkOperations
extends Object
implements SessionOperations

Responsible for providing ClientSDK implementations of the SessionOperations.

Importantly they use the SessionRequest PLL mechanism for performing these operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INVALID_SESSION_STATE
protected static String	UNEXPECTED_SESSION

Constructor Summary

Constructors

Constructor and Description
ClientSdkOperations(Debug sessionDebug, SessionPLLSender sessionPLLSender, SessionServiceURLService sessionServiceURLService)

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(Session session, String url) Add a session listener notification url.
boolean	checkSessionExists(SessionID sessionId) Check whether a session identified by {code sessionId} can be retrieved.
String	deferenceRestrictedID(Session session, SessionID restrictedID) Given a restricted token, returns the SSOTokenID of the master token can only be used if the requester is an app token
void	destroy(Session requester, Session session) Destroys the Session via the Session remote service URL.
Collection<PartialSession>	getMatchingSessions(CrestQuery crestQuery) Returns partial sessions from the session service backend that matches the provided CREST query.
String	getRestrictedTokenId(SessionID masterSid, TokenRestriction restriction) Gets the restricted token ID for a session.
SessionInfo	getSessionInfo(SessionID sid, boolean reset) Get the Session Info Object from the Session ID.
SearchResults<SessionInfo>	getValidSessions(Session session, String pattern) Returns all sessions which are accessible using the provided session for authorization, and which match the provided filter.
void	logout(Session session) Performs a logout operation by making a remote request based on the Sessions service URL.
SessionInfo	refresh(Session session, boolean reset) Performs a refresh of the Session and return a summary of the Session information.
Session	resolveSession(SessionID sessionID) Retrieves the Session from the Session ID.
void	setExternalProperty(SSOToken clientToken, SessionID sessionId, String name, String value) Sets an external property in the session.
void	setProperty(Session session, String name, String value) Perform a remote setProperty on the Session using the remote Service URL.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INVALID_SESSION_STATE

protected static final String INVALID_SESSION_STATE

See Also:

Constant Field Values

UNEXPECTED_SESSION

protected static final String UNEXPECTED_SESSION

See Also:

Constant Field Values

Constructor Detail

ClientSdkOperations

public ClientSdkOperations(Debug sessionDebug,
                           SessionPLLSender sessionPLLSender,
                           SessionServiceURLService sessionServiceURLService)

Method Detail

refresh

public SessionInfo refresh(Session session,
                           boolean reset)
                    throws SessionException

Description copied from interface: SessionOperations

Performs a refresh of the Session and return a summary of the Session information. This will optionally update the last modified timestamp of the Session. Note: This method is inconsistent from the other two in that it requires a Session reference. This is because of a dependency which could not be resolved without substantial refactoring in the Remote implementation.

Specified by:

refresh in interface SessionOperations

Parameters:

session - The Session to update.

reset - If true, then update the last modified timestamp of the Session.

Returns:

Throws:

SessionException

logout

public void logout(Session session)
            throws SessionException

Performs a logout operation by making a remote request based on the Sessions service URL.

Specified by:

logout in interface SessionOperations

Parameters:

session - Session to logout.

Throws:

SessionException

resolveSession

public Session resolveSession(SessionID sessionID)
                       throws SessionException

Description copied from interface: SessionOperations

Retrieves the Session from the Session ID.

Specified by:

resolveSession in interface SessionOperations

Parameters:

sessionID - the ID of the session to resolve

Returns:

the Session Object

Throws:

SessionException - if the session could not be accessed.

getValidSessions

public SearchResults<SessionInfo> getValidSessions(Session session,
                                                   String pattern)
                                            throws SessionException

Description copied from interface: SessionOperations

Returns all sessions which are accessible using the provided session for authorization, and which match the provided filter. Will return early if size or time limits are exceeded.

Specified by:

getValidSessions in interface SessionOperations

Parameters:

session - The session to use for authorization.

pattern - The pattern to use to match the sessions.

Returns:

The list of sessioninfos found, capped based on time and quantity.

Throws:

SessionException - If the request fails.

getMatchingSessions

public Collection<PartialSession> getMatchingSessions(CrestQuery crestQuery)

Description copied from interface: SessionOperations

Returns partial sessions from the session service backend that matches the provided CREST query. The resultset size is limited by the session service's "iplanet-am-session-max-session-list-size" attribute. The returned sessions are only "partial" sessions, meaning that they do not represent the full session state.

Specified by:

getMatchingSessions in interface SessionOperations

Parameters:

crestQuery - The CREST query based on which we should look for matching sessions.

Returns:

The collection of matching partial sessions.

destroy

public void destroy(Session requester,
                    Session session)
             throws SessionException

Destroys the Session via the Session remote service URL.

Specified by:

destroy in interface SessionOperations

Parameters:

requester - The requester's non null session used to authorize the destroy operation.

session - The non null session to destroy.

Throws:

SessionException - If there was an error while deleting the token.

setProperty

public void setProperty(Session session,
                        String name,
                        String value)
                 throws SessionException

Perform a remote setProperty on the Session using the remote Service URL. Assigns the property to the Session.

Specified by:

setProperty in interface SessionOperations

Parameters:

session - The session to perform the set on.

name - Non null name of the property.

value - Non null value.

Throws:

SessionException - SessionException if the session reached its maximum session time, or the session was destroyed, or there was an error during communication with session service, or if the property name or value was null.

getSessionInfo

public SessionInfo getSessionInfo(SessionID sid,
                                  boolean reset)

Description copied from interface: SessionOperations

Get the Session Info Object from the Session ID.

Specified by:

getSessionInfo in interface SessionOperations

Parameters:

sid - the Session Id of the required Session Info.

reset - if true will cause the last access time on the session to be updated.

Returns:

a Session Info object for the required session.

addSessionListener

public void addSessionListener(Session session,
                               String url)
                        throws SessionException

Description copied from interface: SessionOperations

Add a session listener notification url. The url will receive a notification when session change events occur.

Specified by:

addSessionListener in interface SessionOperations

Parameters:

session - the session to listen to.

url - the listener notification url

Throws:

SessionException - if the session could not be accessed.

checkSessionExists

public boolean checkSessionExists(SessionID sessionId)
                           throws SessionException

Description copied from interface: SessionOperations

Check whether a session identified by {code sessionId} can be retrieved.

Specified by:

checkSessionExists in interface SessionOperations

Parameters:

sessionId - the session ID to check.

Returns:

returns true if the session is local

Throws:

SessionException - if the session could not be accessed.

getRestrictedTokenId

public String getRestrictedTokenId(SessionID masterSid,
                                   TokenRestriction restriction)
                            throws SessionException

Description copied from interface: SessionOperations

Gets the restricted token ID for a session.

Specified by:

getRestrictedTokenId in interface SessionOperations

Parameters:

masterSid - the master session id to get the restricted token id for

restriction - the Token Restriction type to use

Returns:

a Restricted token ID as a String

Throws:

SessionException - if the session could not be accessed.

deferenceRestrictedID

public String deferenceRestrictedID(Session session,
                                    SessionID restrictedID)
                             throws SessionException

Description copied from interface: SessionOperations

Given a restricted token, returns the SSOTokenID of the master token can only be used if the requester is an app token

Specified by:

deferenceRestrictedID in interface SessionOperations

Parameters:

session - Must be an app token

restrictedID - The SSOTokenID of the restricted token

Returns:

The SSOTokenID string of the master token

Throws:

SessionException - If the master token cannot be de-referenced

setExternalProperty

public void setExternalProperty(SSOToken clientToken,
                                SessionID sessionId,
                                String name,
                                String value)
                         throws SessionException

Description copied from interface: SessionOperations

Sets an external property in the session. If the property is protected then it will throw a SessionException.

Specified by:

setExternalProperty in interface SessionOperations

Parameters:

clientToken - SSO Token of the client setting external property.

sessionId - The Id of the session to set the property on

name - the name of the property

value - the new value of the property

Throws:

SessionException - If the Session could not be accessed or the property is protected.