net.officefloor.plugin.web.http.session

Interface HttpSessionAdministration

All Known Implementing Classes:

ServletHttpSession

public interface HttpSessionAdministration

Administration interface for the HttpSession.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
void	invalidate(boolean isRequireNewSession) Triggers invalidating the HttpSession.
boolean	isOperationComplete() Indicates if the invalidate or store operation are complete.
void	store() Triggers storing the HttpSession.

Method Detail

invalidate

void invalidate(boolean isRequireNewSession)
         throws Throwable

Triggers invalidating the HttpSession.

Parameters:

isRequireNewSession - true to have a new HttpSession created.

Throws:

Throwable - If immediate failure in invalidating the HttpSession.

store

void store()
    throws Throwable

Triggers storing the HttpSession.

Throws:

Throwable - If immediate failure in storing the HttpSession.

isOperationComplete

boolean isOperationComplete()
                     throws Throwable

Indicates if the invalidate or store operation are complete.

As is an AsynchronousManagedObject, the next time a new Task is run the operation should be complete. This method enables determining if completed immediately and there were no failures of the operation.

Returns:

true if the invalidate or store operation is complete.

Throws:

Throwable - Possible failure in invalidating or storing the HttpSession.