com.ibm.websphere.xs.sessionmanager
Interface SessionIDOverride

public interface SessionIDOverride

This interface can be implemented by WXS Http session replication users who want to control the user session identifier. Any implementation will be instantiated with a no argument constructor.

Since:

8.6

Nested Class Summary

static interface	SessionIDOverride.InitializationContext An implementation of this interface will be passed in to all SessionIDOverride.init(InitializationContext) calls so the SessionIDOverride implementation can be initialized
static interface	SessionIDOverride.SessionIDContext An implementation of this interface will be passed in to all SessionIDOverride.getID(SessionIDContext) calls so the SessionIDOverride implementation can determine the unique session identifier for the end user

Method Summary

void	destroy() This method will be called by the WXS Http session client when a web application is destroyed, typically when a web application is stopped.
String	getID(SessionIDOverride.SessionIDContext ctx) Returns a session identifier based on the SessionIDContext.
void	init(SessionIDOverride.InitializationContext ctx) This method will be called by the WXS Http session client when a web application is first initialized, typically the first request to a web application.

Method Detail

init

void init(SessionIDOverride.InitializationContext ctx)

This method will be called by the WXS Http session client when a web application is first initialized, typically the first request to a web application. The InitializationContext is passed in for the user to cache anything that may be of use when the getID method is subsequently called.

Parameters:

ctx - the context parameters to be used to initialize the plug-in.

destroy

void destroy()

This method will be called by the WXS Http session client when a web application is destroyed, typically when a web application is stopped. The user can cleanup any data they may have cached at this time.

getID

String getID(SessionIDOverride.SessionIDContext ctx)

Returns a session identifier based on the SessionIDContext.

This method will be called by the WXS Http session client to determine the identifier that will be used to store the session data in the grid.

In order to use this non-default option, the application must set a cookie or have some other method to uniquely identify end users via the HttpServletRequest.

This method will be called by the WXS Http session client rather than the standard HttpSession.getId() API. If the method returns null, the session will be stored in the data grid with the default HttpSession.getId() method.

Parameters:

ctx - the context parameters to be used to retrieve the session identifier.

Returns:

the unique user session identifier