org.mentawai.filter

Class HeaderFilter

java.lang.Object

org.mentawai.filter.HeaderFilter

All Implemented Interfaces:

Filter

public class HeaderFilter
extends Object
implements Filter

This filter will place a http header value in the action input. The header value will come from the action input method getHeader.

Author:

Sergio Oliveira Jr.

Constructor Summary

Constructors

Constructor and Description
HeaderFilter(String name)
HeaderFilter(String name, String header)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Gives a chance to the filter to deallocalte any resources before it is destroyed.
String	filter(InvocationChain chain) Executes the filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderFilter

public HeaderFilter(String name)

HeaderFilter

public HeaderFilter(String name,
            String header)

Method Detail

filter

public String filter(InvocationChain chain)
              throws Exception

Description copied from interface: Filter

Executes the filter.

Specified by:

filter in interface Filter

Parameters:

chain - The InvocationChain for the action this filter is being applied to.

Returns:

The result of the filter or the action the filter is being applied to.

Throws:

Exception

destroy

public void destroy()

Description copied from interface: Filter

Gives a chance to the filter to deallocalte any resources before it is destroyed. This is called when the web application is stopped, in other words, this has nothing to do with garbage collection.

Specified by:

destroy in interface Filter