nl.gx.webmanager.handler.forms.handling
Class IncludeToSessionHandler

java.lang.Object
  nl.gx.webmanager.handler.forms.handling.IncludeToSessionHandler

All Implemented Interfaces:

FormComponent, Handler

public class IncludeToSessionHandler
extends java.lang.Object
implements Handler

This handler makes an HTTP request and stores the resulting xml in the session of the client. The xml will be stored in the session of the user if the sessionkey parameter is not null. The xml will be stored in the global values of the user, if the key parameter is not null.

Variable	Type	Mode	Default	Description
url	Parameter	Required	-	The url for the request.
sessionkey	Parameter	Optional	-	The key in the session for storing the result.
key	Parameter	Optional	-	The key in the global values for storing the result.

Example usage:

• Request latest news item from an external site to display on your site.

Constructor Summary

IncludeToSessionHandler()

Method Summary

void	doHandle(FormDefinition form, State formState, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Processes the form.
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

IncludeToSessionHandler

public IncludeToSessionHandler()

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

doHandle

public void doHandle(FormDefinition form,
                     State formState,
                     javax.servlet.http.HttpServletRequest req,
                     javax.servlet.http.HttpServletResponse res)
              throws HandleException

Description copied from interface: Handler

Processes the form.

Specified by:

doHandle in interface Handler

Parameters:

form - The definition of the form for which the submitted values should be handled.

formState - The session values for the form

req - The http request

res - The http response

Throws:

HandleException - If the form values could not be handled correctly