org.jboss.web.tomcat.tc5.session
Interface AbstractJBossManager

All Known Implementing Classes:

JBossManager (src) , JBossManagerCMP (src)

public interface AbstractJBossManager

Common interface for the http session replication managers.

init

public void init(java.lang.String name,
                 WebMetaData (src)  webMetaData,
                 boolean useJK,
                 boolean useLocalCache)
          throws ClusteringNotSupportedException (src) 

Initialize the manager with the web metadata and

Parameters:

name -

webMetaData -

useJK -

useLocalCache -

Throws:

ClusteringNotSupportedException (src)

getInvalidateSessionPolicy

public int getInvalidateSessionPolicy()

The session invalidation policy. One of: SESSION_INVALIDATE_ACCESS =0; SESSION_INVALIDATE_SET_AND_GET =1; SESSION_INVALIDATE_SET_AND_NON_PRIMITIVE_GET =2; SESSION_INVALIDATE_SET =3;

Returns:

the invalidation policy constant

getJvmRoute

public java.lang.String getJvmRoute()

Retrieve the JvmRoute for the enclosing Engine.

Returns:

the JvmRoute or null.

setNewSessionCookie

public void setNewSessionCookie(java.lang.String sessionId,
                                HttpServletResponse response)

Sets a new cookie for the given session id and response

Parameters:

sessionId - The session id

removeLocal

public void removeLocal(Session session)

Remove the active session locally from the manager without replicating to the cluster. This can be useful when the session is exipred, for example, where there is not need to propagate the expiration.

Parameters:

session -

storeSession

public boolean storeSession(Session session)

Store the modified session.

Parameters:

session -