nl.gx.webmanager.handler.forms.routing
Class RequestRouter

java.lang.Object
  nl.gx.webmanager.handler.forms.routing.RequestRouter

All Implemented Interfaces:

FormComponent, Router

public class RequestRouter
extends java.lang.Object
implements Router

Router for redirecting to a URL which is specified in the parameters of the router. This is always the last router in a sequence and will automatically be added to the flow if it is not defined manually.

Variable	Type	Mode	Default	Description
endofflow	Parameter	Required	false	If true, the flow XML will be removed from session.
requestparameter	Parameter	Required	-	The name of the request parameter that holds the target URL.

Example usage:

• Bring the webuser back to the requested webpage after he logged on.
• Bring the webuser back to the page after an error message.
• If the webuser clicks on the [Back] button (already filled in values on this step are remembered and will be displayed the moment the webuser returns on this step).

Constructor Summary

RequestRouter()

Method Summary

RoutingResult	doRouting(FormDefinition form, State formState, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Performs routing based on the form definition and the values of the client.
void	init(FormComponentConfig config) Passes the initialization parameters to the component.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestRouter

public RequestRouter()

Method Detail

init

public void init(FormComponentConfig config)
          throws InitializationException

Description copied from interface: FormComponent

Passes the initialization parameters to the component.

Specified by:

init in interface FormComponent

Parameters:

config - The FormComponentConfig object that contains configutation information for this component.

Throws:

InitializationException - If initialization failed

doRouting

public RoutingResult doRouting(FormDefinition form,
                               State formState,
                               javax.servlet.http.HttpServletRequest req,
                               javax.servlet.http.HttpServletResponse res)

Description copied from interface: Router

Performs routing based on the form definition and the values of the client.

Specified by:

doRouting in interface Router

Parameters:

form - The definition of the current form flow

formState - The object representing the state of the client filling out a form.

req - The http servlet request

res - The http servlet response

Returns:

The routing result for the form, or null if the router doesn't match