atg.droplet

Class FormHandlerExecutor

java.lang.Object

atg.droplet.FormHandlerExecutor

public class FormHandlerExecutor
extends java.lang.Object

This class invokes the form handler based on handle method provided in constructor. Forwards are disabled and the request and response are wrapped to capture any redirect response in the result instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FormHandlerExecutor.DefaultDynamoHttpServletRequestWrapper Class for a default request wrapper to handle calls to the form handler.
class	FormHandlerExecutor.DefaultDynamoHttpServletResponse Class for a default response to handle calls to the form handler.
class	FormHandlerExecutor.FormHandlerInvocationResult It holds the form handler result and actual form handler which is invoked.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	DROPLET_DESCRIPTOR_CANT_FIND_COMPONENT
static java.lang.String	INVALID_FORM_HANDLER The Constant INVALID_FORM_HANDLER.
static java.lang.String	NULL Placeholder value for null.

Constructor Summary

Constructors

Constructor and Description
FormHandlerExecutor(java.lang.String pFormHandler, java.lang.String pHandlerMethod) Create a new FormHandlerExecutor element.

Method Summary

Modifier and Type	Method and Description
void	addInput(java.lang.String pName, java.lang.Object pValue) Adds an input field to this form.
void	addInput(java.lang.String pName, java.lang.Object pValue, java.lang.String pType, java.lang.String pFormName, int pPriority, java.lang.String pDefault, TagConverter pConverter, java.util.Properties pConverterArgs) Adds an input field to this form.
void	addInput(java.lang.String pName, java.lang.Object pValue, TagConverter pConverter, java.util.Properties pConverterArgs) Adds an input field to this form.
void	addRequestData(java.util.Map<java.lang.String,java.lang.String> pValues) Adds the given keys (and values) to the request as parameters.
protected void	checkInputType(java.lang.String pType) Check to type of the form input field.
FormHandlerExecutor.FormHandlerInvocationResult	createFormHandlerInvocationResult() Calls methods to create a request and response and then creates a form handler invocation result object to hold the result of invoking the form handler.
DynamoHttpServletRequest	createRequestWrapper() Creates a request to handle calls to the form handler.
DynamoHttpServletResponse	createResponse() Creates a response to use in calls to the form handler.
FormHandlerExecutor.FormHandlerInvocationResult	execute() It builds the form tag and sends an event which internally execute the form handler and returns the result back.
java.lang.String	getErrorURLProperty(java.lang.String pHandlerMethod) Method to workaround a form handler redirect bug 13572977 which can result in form handler processing continuing even after an error if the error url is null.
java.lang.Object	getFormHandler() Gets the resolved form handler.
FormTag	getFormTag() Return the form tag.
java.util.Set<java.lang.String>	getInputNames() Returns a Set containing the names of the input fields on this form.
java.lang.Object	getInputValues(java.lang.String pName) Returns the value of an input with the given name, pName.
java.lang.String	getXssFiltering() Gets the xss filtering.
boolean	isRequiresSessionConfirmation() Checks if is requires session confirmation.
void	processFormHandlerResult(FormHandlerExecutor.FormHandlerInvocationResult pFormHandlerResult) Check for form exceptions and errors on the result of the form handler invocation.
void	setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation) Sets the requires session confirmation.
protected void	setValueParametersOnExistingRequest(DynamoHttpServletRequest pRequest) Set the value parameters dynamically on an existing request.
void	setXssFiltering(java.lang.String pXssFiltering) Sets the xss filtering.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

NULL

public static final java.lang.String NULL

Placeholder value for null.

See Also:

Constant Field Values

INVALID_FORM_HANDLER

public static final java.lang.String INVALID_FORM_HANDLER

The Constant INVALID_FORM_HANDLER.

See Also:

Constant Field Values

DROPLET_DESCRIPTOR_CANT_FIND_COMPONENT

public static final java.lang.String DROPLET_DESCRIPTOR_CANT_FIND_COMPONENT

See Also:

Constant Field Values

Constructor Detail

FormHandlerExecutor

public FormHandlerExecutor(java.lang.String pFormHandler,
                           java.lang.String pHandlerMethod)
                    throws DropletException

Create a new FormHandlerExecutor element.

Parameters:

pFormHandler - the form's name (Nucleus absolute path)

pHandlerMethod - the handler method

Throws:

DropletException - the droplet exception

Method Detail

getXssFiltering

public java.lang.String getXssFiltering()

Gets the xss filtering.

Returns:

the xss filtering

setXssFiltering

public void setXssFiltering(java.lang.String pXssFiltering)

Sets the xss filtering.

Parameters:

pXssFiltering - the new xss filtering

isRequiresSessionConfirmation

public boolean isRequiresSessionConfirmation()

Checks if is requires session confirmation.

Returns:

true, if is requires session confirmation

setRequiresSessionConfirmation

public void setRequiresSessionConfirmation(boolean pRequiresSessionConfirmation)

Sets the requires session confirmation.

Parameters:

pRequiresSessionConfirmation - the new requires session confirmation

createFormHandlerInvocationResult

public FormHandlerExecutor.FormHandlerInvocationResult createFormHandlerInvocationResult()
                                                                                  throws java.io.IOException

Calls methods to create a request and response and then creates a form handler invocation result object to hold the result of invoking the form handler.

Returns:

FormHandlerInvocationResult holder

Throws:

java.io.IOException

createRequestWrapper

public DynamoHttpServletRequest createRequestWrapper()

Creates a request to handle calls to the form handler. This implementation uses the internal DefaultDynamoHttpServletRequestWrapper which turns off forwarding.

Returns:

DynamoHttpServletRequest to be used for form handler invocation.

createResponse

public DynamoHttpServletResponse createResponse()
                                         throws java.io.IOException

Creates a response to use in calls to the form handler. This implementation uses the internal DefaultDynamoHttpServletResponse that prevents the request from being redirected, capturing the URL instead. It will also capture any attempt to set the response status code and writes to the output stream.

Returns:

DynamoHttpServletResponse to be used for form handler invocation.

Throws:

java.io.IOException

addInput

public void addInput(java.lang.String pName,
                     java.lang.Object pValue)
              throws javax.servlet.ServletException

Adds an input field to this form.

Parameters:

pName - the name of the input field (this is also the parameter name).

pValue - the value of the input field.

Throws:

javax.servlet.ServletException - if an error occurs

addInput

public void addInput(java.lang.String pName,
                     java.lang.Object pValue,
                     TagConverter pConverter,
                     java.util.Properties pConverterArgs)
              throws javax.servlet.ServletException

Adds an input field to this form.

Parameters:

pName - the name of the input field (this is also the parameter name).

pValue - the value of the input field.

pConverter - the TagConverter to use (null means no converter)

pConverterArgs - the converter args to use (null means no converter args)

Throws:

javax.servlet.ServletException - if an error occurs

addInput

public void addInput(java.lang.String pName,
                     java.lang.Object pValue,
                     java.lang.String pType,
                     java.lang.String pFormName,
                     int pPriority,
                     java.lang.String pDefault,
                     TagConverter pConverter,
                     java.util.Properties pConverterArgs)
              throws javax.servlet.ServletException

Adds an input field to this form.

Parameters:

pName - the name of the input field (this is also the parameter name).

pValue - the value of the input field.

pType - the form type.

pFormName - the Nucleus path of the form.

pPriority - the input form tag priority.

pDefault - a String value

pConverter - the TagConverter to use (null means no converter)

pConverterArgs - the converter args to use (null means no converter args)

Throws:

javax.servlet.ServletException - if an error occurs

addRequestData

public void addRequestData(java.util.Map<java.lang.String,java.lang.String> pValues)

Adds the given keys (and values) to the request as parameters.

Parameters:

pValues - a map of keys and values

checkInputType

protected void checkInputType(java.lang.String pType)

Check to type of the form input field. Throws IllegalArgumentException is the type is unknown. It supports only two types "hidden" or "password".

Parameters:

pType - the type of the form input field.

getInputNames

public java.util.Set<java.lang.String> getInputNames()

Returns a Set containing the names of the input fields on this form. The order in the iterator matches the order in which addInput was called.

Returns:

the input names

getInputValues

public java.lang.Object getInputValues(java.lang.String pName)

Returns the value of an input with the given name, pName.

Parameters:

pName - the name

Returns:

the input values

getFormTag

public FormTag getFormTag()

Return the form tag. The form tag reflects fields added as addInput() are invoked.

Returns:

the form tag.

getFormHandler

public java.lang.Object getFormHandler()

Gets the resolved form handler.

Returns:

the form handler

setValueParametersOnExistingRequest

protected void setValueParametersOnExistingRequest(DynamoHttpServletRequest pRequest)

Set the value parameters dynamically on an existing request. This generally works fine, but does not support multi-value parameters, since the form invoking code makes calls that look explicitly at the incoming parameter hashtable.

Parameters:

pRequest - the new value parameters on existing request

getErrorURLProperty

public java.lang.String getErrorURLProperty(java.lang.String pHandlerMethod)

Method to workaround a form handler redirect bug 13572977 which can result in form handler processing continuing even after an error if the error url is null. This workaround tries to determine the error url property name based on the handle method name.

Parameters:

pHandlerMethod - Form handler method that will be invoked

Returns:

error URL property name or null if it could not or should not be automatically determined

execute

public FormHandlerExecutor.FormHandlerInvocationResult execute()
                                                        throws DropletException

It builds the form tag and sends an event which internally execute the form handler and returns the result back.

Returns:

result of the form handler execution

Throws:

DropletException - the droplet exception

processFormHandlerResult

public void processFormHandlerResult(FormHandlerExecutor.FormHandlerInvocationResult pFormHandlerResult)
                              throws DropletException

Check for form exceptions and errors on the result of the form handler invocation.

Parameters:

pFormHandlerResult - the result of the form handler invocation

Throws:

DropletException - containing the exceptions that have occurred