Package org.onehippo.forge.pageflow.core.rt.impl

Class HttpSessionPageFlowStore

java.lang.Object

org.onehippo.forge.pageflow.core.rt.impl.HttpSessionPageFlowStore

All Implemented Interfaces:

PageFlowStore

public class HttpSessionPageFlowStore
extends Object
implements PageFlowStore

Constructor Summary

Constructors

Constructor	Description
HttpSessionPageFlowStore()

Method Summary

Modifier and Type	Method	Description
PageFlow	getPageFlow(javax.servlet.http.HttpServletRequest request, String flowId)	Find and retrieve the PageFlow instance by the identifier of the PageFlow (flowId) from the backend storage.
boolean	removePageFlow(javax.servlet.http.HttpServletRequest request, String flowId)	Remove the associated pageFlow from the backend storage by the flowId.
boolean	storePageFlow(javax.servlet.http.HttpServletRequest request, String flowId, PageFlow pageFlow)	Store the pageFlow into the backend storage by the flowId.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSessionPageFlowStore

public HttpSessionPageFlowStore()

Method Detail

getPageFlow

public PageFlow getPageFlow(javax.servlet.http.HttpServletRequest request,
                            String flowId)
                     throws PageFlowException

Description copied from interface: PageFlowStore

Find and retrieve the PageFlow instance by the identifier of the PageFlow (flowId) from the backend storage. Return null if not found.

Specified by:

getPageFlow in interface PageFlowStore

Parameters:

request - HttpServletRequest object

flowId - the identifier of the PageFlow

Returns:

the PageFlow instance by the identifier of the PageFlow (flowId) from the backend storage, or null if not found

Throws:

PageFlowException - if any exception occurs

storePageFlow

public boolean storePageFlow(javax.servlet.http.HttpServletRequest request,
                             String flowId,
                             PageFlow pageFlow)
                      throws PageFlowException

Description copied from interface: PageFlowStore

Store the pageFlow into the backend storage by the flowId.

Specified by:

storePageFlow in interface PageFlowStore

Parameters:

request - HttpServletRequest object

flowId - the identifier of the PageFlow

pageFlow - PageFlow instance

Returns:

true if stored

Throws:

PageFlowException - if any exception occurs

removePageFlow

public boolean removePageFlow(javax.servlet.http.HttpServletRequest request,
                              String flowId)
                       throws PageFlowException

Description copied from interface: PageFlowStore

Remove the associated pageFlow from the backend storage by the flowId.

Specified by:

removePageFlow in interface PageFlowStore

Parameters:

request - HttpServletRequest object

flowId - the identifier of the PageFlow

Returns:

true if removed

Throws:

PageFlowException - if any exception occurs