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

Interface PageFlowControl

All Known Implementing Classes:

DefaultHstPageFlowControl, DefaultPageFlowControl

public interface PageFlowControl

Page Flow Control abstraction, which provides applications with an easier way to retrieve the current PageFlow instance from the HttpServletRequest, to send redirection to a specific PageState and to complete a PageFlow.

For example, an application can use this interface like the following example:

 final PageFlowControl flowControl = PageFlowControl.getDefault(request);
 final PageFlow pageFlow = flowControl.getPageFlow(request);
 ...
 

Field Summary

Fields

Modifier and Type	Field	Description
static String	PAGE_FLOW_CONTROL_ATTR_NAME	The servlet context or request attribute name by which a PageFlowControl instance is stored for an application.
static String	PAGE_FLOW_ID_ATTR_NAME
static String	PAGE_FLOW_ID_PROP_NAME	The request parameter name by which the identifier of a PageFlow could be inferred if provided.

Method Summary

Modifier and Type	Method	Description
void	completePageFlow(javax.servlet.http.HttpServletRequest request, PageFlow pageFlow)
static PageFlowControl	getDefault(javax.servlet.ServletRequest request)
PageFlow	getPageFlow(javax.servlet.http.HttpServletRequest request)
void	sendRedirect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, PageState pageState)

Field Detail

PAGE_FLOW_CONTROL_ATTR_NAME

static final String PAGE_FLOW_CONTROL_ATTR_NAME

The servlet context or request attribute name by which a PageFlowControl instance is stored for an application.

PAGE_FLOW_ID_PROP_NAME

static final String PAGE_FLOW_ID_PROP_NAME

The request parameter name by which the identifier of a PageFlow could be inferred if provided.

See Also:

Constant Field Values

PAGE_FLOW_ID_ATTR_NAME

static final String PAGE_FLOW_ID_ATTR_NAME

Method Detail

getDefault

static PageFlowControl getDefault(javax.servlet.ServletRequest request)

getPageFlow

PageFlow getPageFlow(javax.servlet.http.HttpServletRequest request)
              throws PageFlowException

Throws:

PageFlowException

sendRedirect

void sendRedirect(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response,
                  PageState pageState)
           throws PageFlowException,
                  IOException,
                  IllegalStateException

Throws:

PageFlowException

IOException

IllegalStateException

completePageFlow

void completePageFlow(javax.servlet.http.HttpServletRequest request,
                      PageFlow pageFlow)
               throws PageFlowException

Throws:

PageFlowException