net.wgen.op.http.filter
Class ParamTrigger

java.lang.Object
  net.wgen.op.http.filter.ParamTrigger

public class ParamTrigger

extends java.lang.Object

Fired by the ParamTriggerFilter when it claims responds to a parameter name.

Version:

$Id: ParamTrigger.html,v 1.2 2007/01/28 04:09:37 paulfeuer Exp $

Author:

Paul Feuer, Wireless Generation, Inc.

Field Summary

private java.util.List	_listeners
private java.lang.String	_name
private java.lang.String	_parameterName
private java.lang.String	_sessionAttributeKey
private java.lang.String	_sessionRemoveValue
private static org.apache.log4j.Logger	LOG

Constructor Summary

ParamTrigger(java.lang.String parameterName)

ParamTrigger(java.lang.String parameterName, java.lang.String sessionAttributeKey, java.lang.String sessionRemoveValue)

ParamTrigger(java.lang.String name, java.lang.String parameterName, java.lang.String sessionAttributeKey, java.lang.String sessionRemoveValue)

Method Summary

void	addListener(ParamTriggerListener listener) Register a listener for trigger firing.
protected void	evaluateSessionStoring(java.lang.String parameterName, java.lang.String value, ParamTriggerState triggerState, javax.servlet.http.HttpServletRequest request) If there is a specified _sessionAttributeKey, we should store the value in the session attributes unless the value is equal to the _sessionRemoveValue, in which case we should remove the session attribute.
protected void	fireSessionStoredAttribs(ParamTriggerState triggerState, javax.servlet.http.HttpServletRequest request) Called by the ParamTriggerFilter after processing the querystring to pull additional values out of the session attributes.
protected void	fireTrigger(java.lang.String parameterName, java.lang.String value, ParamTriggerState triggerState, javax.servlet.http.HttpServletRequest request)
java.lang.String	getName() The name of the trigger.
protected void	notifyListeners(java.lang.String parameterName, java.lang.Object value, ParamTriggerState triggerState) Fire the listeners registered for this trigger.
protected void	notifyOfRequestCompletion(ParamTriggerState triggerState, javax.servlet.http.HttpServletRequest request) Called by the ParamTriggerFilter when the filterChain returns from processing.
void	removeListener(ParamTriggerListener listener) Remove that listener from trigger firings.
protected boolean	respondsTo(java.lang.String parameterName) Whether or not this trigger cares at all about the parameter.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final org.apache.log4j.Logger LOG

_name

private java.lang.String _name

_parameterName

private java.lang.String _parameterName

_sessionAttributeKey

private java.lang.String _sessionAttributeKey

_sessionRemoveValue

private java.lang.String _sessionRemoveValue

_listeners

private java.util.List _listeners

Constructor Detail

ParamTrigger

public ParamTrigger(java.lang.String parameterName)

ParamTrigger

public ParamTrigger(java.lang.String parameterName,
                    java.lang.String sessionAttributeKey,
                    java.lang.String sessionRemoveValue)

ParamTrigger

public ParamTrigger(java.lang.String name,
                    java.lang.String parameterName,
                    java.lang.String sessionAttributeKey,
                    java.lang.String sessionRemoveValue)

Method Detail

getName

public java.lang.String getName()

The name of the trigger.

Returns:

the name of the trigger

respondsTo

protected boolean respondsTo(java.lang.String parameterName)

Whether or not this trigger cares at all about the parameter.

Parameters:

parameterName -

Returns:

whether or not this trigger cares at all about the parameter

addListener

public void addListener(ParamTriggerListener listener)

Register a listener for trigger firing.

Parameters:

listener -

removeListener

public void removeListener(ParamTriggerListener listener)

Remove that listener from trigger firings.

Parameters:

listener -

fireSessionStoredAttribs

protected void fireSessionStoredAttribs(ParamTriggerState triggerState,
                                        javax.servlet.http.HttpServletRequest request)

Called by the ParamTriggerFilter after processing the querystring to pull additional values out of the session attributes.

Parameters:

triggerState -

request -

fireTrigger

protected void fireTrigger(java.lang.String parameterName,
                           java.lang.String value,
                           ParamTriggerState triggerState,
                           javax.servlet.http.HttpServletRequest request)

Parameters:

parameterName -

value -

triggerState -

request -

notifyOfRequestCompletion

protected void notifyOfRequestCompletion(ParamTriggerState triggerState,
                                         javax.servlet.http.HttpServletRequest request)

Called by the ParamTriggerFilter when the filterChain returns from processing.

Parameters:

triggerState -

request -

evaluateSessionStoring

protected void evaluateSessionStoring(java.lang.String parameterName,
                                      java.lang.String value,
                                      ParamTriggerState triggerState,
                                      javax.servlet.http.HttpServletRequest request)

If there is a specified _sessionAttributeKey, we should store the value in the session attributes unless the value is equal to the _sessionRemoveValue, in which case we should remove the session attribute.

Parameters:

parameterName -

value -

triggerState -

request -

notifyListeners

protected void notifyListeners(java.lang.String parameterName,
                               java.lang.Object value,
                               ParamTriggerState triggerState)

Fire the listeners registered for this trigger.

Parameters:

parameterName -

value -

triggerState -