Package com.webmethods.portal.framework

Interface ISessionManager

All Superinterfaces:

IComponent, IComponentProvider, IInitializable, IURIResolver

public interface ISessionManager
extends IComponentProvider

The ISessionManager manages current sessions inside of the IPortalServlet

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GUEST_SESSION	This session is a brand new session
static final int	INVALID_SESSION	This session is an invalid session and should be treated as such
static final String	INVALIDATE_KEY	Setting this attribute tells the SessionManager to invalidate the session in it's removeLocalSession method.
static final String	LOGIN_ERROR_KEY	the flag indicating the error on the login request
static final String	LOGIN_KEY	the login key
static final String	LOGOUT_KEY	the logout key
static final int	NORMAL_SESSION	This session was determined to be a normal session, not requiring special processing
static final String	ORIGINAL_REQUEST_KEY	the original request key
static final String	SESSION_LISTENER	This is used to register with the HttpSession as a listener
static final String	VOLATILE	This is an attribute placed on the session that marks it as 'volatile'

Fields inherited from interface com.webmethods.portal.system.IComponentProvider

ATTR_APP_NAME, ATTR_BEG_QUERY, ATTR_END_QUERY, ATTR_MID_QUERY, BIZPOLICY_MANAGER, CACHE_PROVIDER, COMMAND_PROVIDER, COMPONENTS_QUERY, INSTALL_PROVIDER, MECH_PROVIDER, METACONTEXT_PROVIDER, PHASE_PROVIDER, POLICY_PROVIDER, SEARCH_PROVIDER

Method Summary

Modifier and Type	Method	Description
void	addMorphedSessionPersistentKey(String key)	Adds the given key to the set of keys that will be persisted when a session is morphed from an anonymous session to an non-anonymous session.
int	handleSession(HttpServletRequest request, HttpServletResponse response)	This is the main entry for the ISessionManager.
boolean	hasLoginError(HttpServletRequest request)	Determine if this request has a login error
boolean	isLoginRequest(HttpServletRequest request)	Determine if the user has logged into the system
void	removeLoginError(HttpServletRequest request)	Remove the login error key
void	removeLoginKey(HttpServletRequest request)	This removes the login attribute (@link #LOGIN_KEY} from the request
void	setLoginError(HttpServletRequest request)	Set this request with a login error flag
void	setLoginKey(HttpServletRequest request)
boolean	shouldKeyPersistInMorphedSession(String key)	checks if the given key should be persisted in a session that is changing from an anonymous user to a non-anonymous user.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.IComponentProvider

exists, getComponent, getComponent, getComponent, getComponentQueryString, getComponents, getDefaultComponent, getLogger, initDeferredWebAppComponents, lookup, registerComponent, reloadComponent, reloadComponent, unregisterComponent, upgradeComponentDataFromBootstrapComponentData

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.system.IURIResolver

acquireURI, acquireURI

Field Details

VOLATILE

static final String VOLATILE

This is an attribute placed on the session that marks it as 'volatile'

See Also:

• Constant Field Values

LOGIN_KEY

static final String LOGIN_KEY

the login key

See Also:

• isLoginRequest(javax.servlet.http.HttpServletRequest)
• Constant Field Values

LOGOUT_KEY

static final String LOGOUT_KEY

the logout key

See Also:

• Constant Field Values

INVALIDATE_KEY

static final String INVALIDATE_KEY

Setting this attribute tells the SessionManager to invalidate the session in it's removeLocalSession method.

See Also:

• Constant Field Values

ORIGINAL_REQUEST_KEY

static final String ORIGINAL_REQUEST_KEY

the original request key

See Also:

• Constant Field Values

LOGIN_ERROR_KEY

static final String LOGIN_ERROR_KEY

the flag indicating the error on the login request

See Also:

• Constant Field Values

SESSION_LISTENER

static final String SESSION_LISTENER

This is used to register with the HttpSession as a listener

See Also:

• Constant Field Values

NORMAL_SESSION

static final int NORMAL_SESSION

This session was determined to be a normal session, not requiring special processing

See Also:

• Constant Field Values

GUEST_SESSION

static final int GUEST_SESSION

This session is a brand new session

See Also:

• Constant Field Values

INVALID_SESSION

static final int INVALID_SESSION

This session is an invalid session and should be treated as such

See Also:

• Constant Field Values

Method Details

handleSession

int handleSession(HttpServletRequest request,
 HttpServletResponse response)
           throws PortalException

This is the main entry for the ISessionManager. It allows the manager to verify the validity of the current session

Parameters:

request -

response -

Returns:

one of the ISessionManager response codes

Throws:

PortalException

removeLoginKey

void removeLoginKey(HttpServletRequest request)

This removes the login attribute (@link #LOGIN_KEY} from the request

setLoginKey

void setLoginKey(HttpServletRequest request)

See Also:

• setLoginKey(javax.servlet.http.HttpServletRequest)

setLoginError

void setLoginError(HttpServletRequest request)

Set this request with a login error flag

See Also:

• LOGIN_ERROR_KEY

hasLoginError

boolean hasLoginError(HttpServletRequest request)

Determine if this request has a login error

See Also:

• LOGIN_ERROR_KEY

removeLoginError

void removeLoginError(HttpServletRequest request)

Remove the login error key

See Also:

• LOGIN_ERROR_KEY

isLoginRequest

boolean isLoginRequest(HttpServletRequest request)

Determine if the user has logged into the system

Parameters:

request - the HttpRequest containing the session to validate

Returns:

true if this request is a login request

addMorphedSessionPersistentKey

void addMorphedSessionPersistentKey(String key)

Adds the given key to the set of keys that will be persisted when a session is morphed from an anonymous session to an non-anonymous session.

Parameters:

key - the key to add to the list of persisted keys.

shouldKeyPersistInMorphedSession

boolean shouldKeyPersistInMorphedSession(String key)

checks if the given key should be persisted in a session that is changing from an anonymous user to a non-anonymous user.

Parameters:

key - the key to check for

Returns:

true if the key should be persisted, false otherwise.