com.raritantechnologies.utils.filter
Class SessionDataFilter

java.lang.Object
  com.raritantechnologies.utils.filter.SessionDataFilter

All Implemented Interfaces:

IConfigurable, IStringFilter

public class SessionDataFilter

extends java.lang.Object

implements IStringFilter

Replaces a pattern string with the value of something cached in session data.

XML Configuration Template:

   <StringFilter class="com.raritantechnologies.utils.filter.SessionDataFilter"
                    sessionKey="[name of cached item in session data]"
                    replacePattern="[pattern to replace in target string with session data value]" >
  

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Field Summary

Fields inherited from interface com.raritantechnologies.utils.filter.IStringFilter

TEMPLATE

Constructor Summary

SessionDataFilter()

Method Summary

java.lang.String	filterString(java.util.Map parameters, java.lang.String inputString)
java.lang.String	filterString(java.lang.String inputString)
java.lang.String	filterString(java.lang.String sessionID, java.lang.String inputString)
java.lang.String	getConfigurationXML()
java.lang.String	getConfigurationXML(java.lang.String configurationTemplate)
void	getConfigurationXML(java.io.Writer writer)
java.lang.String	getReplaceToken()
java.lang.String	getSessionKey()
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	setReplaceToken(java.lang.String replaceToken)
void	setSessionKey(java.lang.String sessionKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

SessionDataFilter

public SessionDataFilter()

Method Detail

filterString

public java.lang.String filterString(java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.lang.String sessionID,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

filterString

public java.lang.String filterString(java.util.Map parameters,
                                     java.lang.String inputString)

Specified by:

filterString in interface IStringFilter

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IConfigurable

setSessionKey

public void setSessionKey(java.lang.String sessionKey)

getSessionKey

public java.lang.String getSessionKey()

setReplaceToken

public void setReplaceToken(java.lang.String replaceToken)

getReplaceToken

public java.lang.String getReplaceToken()

getConfigurationXML

public void getConfigurationXML(java.io.Writer writer)
                         throws java.io.IOException

Throws:

java.io.IOException

getConfigurationXML

public java.lang.String getConfigurationXML()

Specified by:

getConfigurationXML in interface IStringFilter

getConfigurationXML

public java.lang.String getConfigurationXML(java.lang.String configurationTemplate)

Specified by:

getConfigurationXML in interface IStringFilter