org.mentawai.filter
Class SessionFilter

java.lang.Object
  extended by org.mentawai.core.InputWrapper
      extended by org.mentawai.filter.SessionFilter
All Implemented Interfaces:
Map, AfterConsequenceFilter, Filter, Input

public class SessionFilter
extends InputWrapper
implements AfterConsequenceFilter

This filter will place the session context in the action input. Note that the SessionContext class is also a Map so it can be easily injected in a pojo action without coupling with the framework API.

Author:
Sergio Oliveira Jr.

Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>
 
Constructor Summary
SessionFilter(String name)
           
 
Method Summary
 void afterConsequence(Action action, Consequence c, boolean conseqExecuted, boolean actionExecuted, String result)
           
 void destroy()
          Gives a chance to the filter to deallocalte any resources before it is destroyed.
 String filter(InvocationChain chain)
          Executes the filter.
 Object getValue(String name)
          Gets a parameter value (any object) with the given name.
 
Methods inherited from class org.mentawai.core.InputWrapper
clear, containsKey, containsValue, entries, entrySet, get, getBoolean, getBoolean, getBooleanValue, getBooleanValue, getDate, getDate, getDate, getDouble, getDouble, getDoubleValue, getDoubleValue, getEnum, getEnums, getFloat, getFloat, getFloatValue, getFloatValue, getHeader, getHeaderKeys, getInt, getInt, getInts, getIntValue, getIntValue, getIntValues, getLong, getLong, getLongs, getLongValue, getLongValue, getObject, getObject, getProperty, getRoot, getString, getStrings, getStringValue, getStringValues, has, hasValue, inject, inject, isEmpty, keys, keySet, put, putAll, remove, removeInput, removeValue, setInput, setValue, size, values
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Constructor Detail

SessionFilter

public SessionFilter(String name)
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

getValue

public Object getValue(String name)
Description copied from interface: Input
Gets a parameter value (any object) with the given name.

Specified by:
getValue in interface Input
Overrides:
getValue in class InputWrapper
Parameters:
name - the name of the parameter
Returns:
the parameter value (any object) or null if it doesn't exist.

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

afterConsequence

public void afterConsequence(Action action,
                             Consequence c,
                             boolean conseqExecuted,
                             boolean actionExecuted,
                             String result)
Specified by:
afterConsequence in interface AfterConsequenceFilter


Copyright © 2013. All Rights Reserved.