shocks.platform.filters
Class Example

java.lang.Object
  extended byshocks.client.FilterSupport
      extended byshocks.platform.filters.Example
All Implemented Interfaces:
Action

public final class Example
extends FilterSupport

This example Filter prints out some information about itself.


Field Summary
 
Fields inherited from class shocks.client.FilterSupport
FAILURE, SUCCESS
 
Constructor Summary
Example()
           
 
Method Summary
protected  java.lang.String execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Developers are required to override this method when writing crosscutting actions.
 
Methods inherited from class shocks.client.FilterSupport
execute, getFilterName, getFilterVersion, getServletContext, setFilterMetadata
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Example

public Example()
Method Detail

execute

protected java.lang.String execute(javax.servlet.http.HttpServletRequest request,
                                   javax.servlet.http.HttpServletResponse response)
Description copied from class: FilterSupport

Developers are required to override this method when writing crosscutting actions. They may perform operations on the request and response objects, make use of the servlet context, get relevant data about the workflow sequence currently in progress, and pass data back and forth between filter components by using the FilterResult object.

This method must return a command string to its enclosing Filter object. There are two standard results which are allowed by the framework: SUCCESS and FAILURE. An example of their use follows:

return SUCCESS;

This tells the workflow processor that execution of the FilterSupport class has been successful and that it should proceed to the next step in the workflow sequence. If any string value other than SUCCESS is returned to the container, it will assume that the workflow sequence has been terminated and return control to the WorkflowController.

Specified by:
execute in class FilterSupport
Parameters:
request -
response -
Returns:
String