org.norther.tammi.spray.filter
Class DefaultKeyFilter

java.lang.Object
  org.norther.tammi.core.base.Adaptee
      org.norther.tammi.spray.filter.DefaultFilter
          org.norther.tammi.spray.filter.DefaultKeyFilter

All Implemented Interfaces:

Serializable, NotificationBroadcaster, NotificationEmitter, Filter, Manageable, MBeanDelegate, KeyFilter

Direct Known Subclasses:

DefaultLocaleFilter, DefaultMonitorFilter, DefaultSecureKeyFilter, DefaultSkinFilter, DefaultTerminalFilter

public class DefaultKeyFilter
extends DefaultFilter
implements KeyFilter

A default implementation of KeyFilter.

Author:

Ilkka Priha

See Also:

Serialized Form

Field Summary

static String

DEFAULT_KEY The default key.

Fields inherited from class org.norther.tammi.core.base.Adaptee

ADAPTEE_NOTIF_DESCRIPTION, ADAPTEE_NOTIFICATIONS

Fields inherited from interface org.norther.tammi.core.base.MBeanDelegate

ARRAY_TYPE, OBJECT_TYPE, PRIMITIVE_TYPE, STRING_TYPE

Constructor Summary

DefaultKeyFilter()
Constructs a new filter.

DefaultKeyFilter(String key)
Constructs a new filter adaptee with a key.

Method Summary

String	getKey() Gets the filter key.
String	getKeyValue(ServletRequest request, ServletResponse response, FilterChain chain) Gets the filter key value for the specified request.
String[]	getKeyValues(ServletRequest request, ServletResponse response, FilterChain chain) Gets filter key values for the specified request.
boolean	isLinkedKey() Checks whether the filter key is part of URL links built within filter chains including this filter.
void	setKey(String key) Sets the filter key.
void	setLinkedKey(boolean flag) Sets the linked key flag.

Methods inherited from class org.norther.tammi.spray.filter.DefaultFilter

destroy, doFilter, getFilterConfig, getRequestMap, getSessionMap, init

Methods inherited from class org.norther.tammi.core.base.Adaptee

addAdaptee, addNotificationListener, getAttributeSupport, getBroker, getCanonicalName, getDomain, getFactory, getLoader, getLog, getLog, getMBean, getMBeanServer, getNotificationInfo, getObjectName, getRegistrationTime, getSequenceNumber, hasListeners, isRegistered, postmanaged, premanaged, removeNotificationListener, removeNotificationListener, sendNotification, sendNotification, sendNotification, sendNotification, unmanaged, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Field Detail

DEFAULT_KEY

public static final String DEFAULT_KEY

The default key.

See Also:

Constant Field Values

Constructor Detail

DefaultKeyFilter

public DefaultKeyFilter()

Constructs a new filter.

DefaultKeyFilter

public DefaultKeyFilter(String key)

Constructs a new filter adaptee with a key.

Parameters:

key - the filter key.

Method Detail

getKey

public String getKey()

Description copied from interface: KeyFilter

Gets the filter key.

Specified by:

getKey in interface KeyFilter

Returns:

the filter key.

setKey

public void setKey(String key)

Description copied from interface: KeyFilter

Sets the filter key.

Specified by:

setKey in interface KeyFilter

Parameters:

key - the filter key.

isLinkedKey

public boolean isLinkedKey()

Description copied from interface: KeyFilter

Checks whether the filter key is part of URL links built within filter chains including this filter.

Specified by:

isLinkedKey in interface KeyFilter

Returns:

true for a linked key, otherwise false.

setLinkedKey

public void setLinkedKey(boolean flag)

Description copied from interface: KeyFilter

Sets the linked key flag. Linked keys and their values are automatically included in URL links built within filter chains including this filter.

Specified by:

setLinkedKey in interface KeyFilter

Parameters:

flag - the linked key flag.

getKeyValue

public String getKeyValue(ServletRequest request,
                          ServletResponse response,
                          FilterChain chain)

Description copied from interface: KeyFilter

Gets the filter key value for the specified request. By default, the method returns the last request parameter mapped to the filter key.

Specified by:

getKeyValue in interface KeyFilter

Parameters:

request - the request.

response - the response.

chain - the filter chain.

Returns:

the key value or null.

getKeyValues

public String[] getKeyValues(ServletRequest request,
                             ServletResponse response,
                             FilterChain chain)

Description copied from interface: KeyFilter

Gets filter key values for the specified request. By default, the method returns request parameter values.

Specified by:

getKeyValues in interface KeyFilter

Parameters:

request - the request.

response - the response.

chain - the filter chain.

Returns:

the key values or null.