jPOS 1.6.1 API Documentation

org.jpos.iso.filter
Class StatefulFilter

java.lang.Object
  extended by org.jpos.iso.filter.StatefulFilter
All Implemented Interfaces:
Configurable, ISOFilter

public class StatefulFilter
extends java.lang.Object
implements ISOFilter, Configurable

Filter that maintains some fields of arriving messages in one direction and put that fields in the message going in the oposite direction that is the answer, based on a key formed by some fields.

Author:
Andrés Alcarraz

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.jpos.iso.ISOFilter
ISOFilter.VetoException
 
Constructor Summary
StatefulFilter()
          Creates a new instance of StateFulFilter
 
Method Summary
 ISOMsg filter(ISOChannel iSOChannel, ISOMsg m, LogEvent evt)
           
 int getIgnoredField(int index)
          Indexed getter for property ignoredFields.
 int[] getIgnoredFields()
          Getter for property ignoredFields.
 int[] getKey()
          Getter for property key.
 int getKey(int index)
          Indexed getter for property key.
 java.lang.String getKeyPrefix()
          Getter for property keyPrefix.
 int getMatchDirection()
          Getter for property matchDirection.
 int getSavedField(int index)
          Indexed getter for property savedFields.
 int[] getSavedFields()
          Getter for property savedFields.
 long getTimeout()
          Getter for property timeout.
 boolean isOverwriteOriginalFields()
          Getter for property overwriteOriginalFields.
 boolean isVetoUnmatched()
          Getter for property vetoUnmatched.
 void setConfiguration(Configuration cfg)
           
 void setIgnoredField(int index, int ignoredFields)
          Indexed setter for property ignoredFields.
 void setIgnoredFields(int[] ignoredFields)
          Setter for property ignoredFields.
 void setKey(int[] key)
          Setter for property key.
 void setKey(int index, int key)
          Indexed setter for property key.
 void setKeyPrefix(java.lang.String keyPrefix)
          Setter for property keyPrefix.
 void setMatchDirection(int matchDirection)
          Setter for property matchDirection.
 void setOverwriteOriginalFields(boolean overwriteOriginalFields)
          Setter for property overwriteOriginalFields.
 void setSavedField(int index, int savedFields)
          Indexed setter for property savedFields.
 void setSavedFields(int[] savedFields)
          Setter for property savedFields.
 void setSpace(java.lang.String uri)
           
 void setTimeout(long timeout)
          Setter for property timeout.
 void setVetoUnmatched(boolean vetoUnmatched)
          Setter for property vetoUnmatched.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StatefulFilter

public StatefulFilter()
Creates a new instance of StateFulFilter

Method Detail

getKeyPrefix

public java.lang.String getKeyPrefix()
Getter for property keyPrefix.

Returns:
Value of property keyPrefix.

setKeyPrefix

public void setKeyPrefix(java.lang.String keyPrefix)
Setter for property keyPrefix.

Parameters:
keyPrefix - New value of property keyPrefix.

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException
Specified by:
setConfiguration in interface Configurable
Parameters:
cfg - Configuration object
Throws:
ConfigurationException

setSpace

public void setSpace(java.lang.String uri)

filter

public ISOMsg filter(ISOChannel iSOChannel,
                     ISOMsg m,
                     LogEvent evt)
              throws ISOFilter.VetoException
Specified by:
filter in interface ISOFilter
Parameters:
iSOChannel - current ISOChannel instance
m - ISOMsg to filter
evt - LogEvent
Returns:
an ISOMsg (possibly parameter m)
Throws:
ISOFilter.VetoException

isVetoUnmatched

public boolean isVetoUnmatched()
Getter for property vetoUnmatched.

Returns:
Value of property vetoUnmatched.

setVetoUnmatched

public void setVetoUnmatched(boolean vetoUnmatched)
Setter for property vetoUnmatched.

Parameters:
vetoUnmatched - New value of property vetoUnmatched.

getMatchDirection

public int getMatchDirection()
Getter for property matchDirection.

Returns:
Value of property matchDirection.

setMatchDirection

public void setMatchDirection(int matchDirection)
Setter for property matchDirection.

Parameters:
matchDirection - New value of property matchDirection.

getIgnoredField

public int getIgnoredField(int index)
Indexed getter for property ignoredFields.

Parameters:
index - Index of the property.
Returns:
Value of the property at index.

getIgnoredFields

public int[] getIgnoredFields()
Getter for property ignoredFields.

Returns:
Value of property ignoredFields.

setIgnoredField

public void setIgnoredField(int index,
                            int ignoredFields)
Indexed setter for property ignoredFields.

Parameters:
index - Index of the property.
ignoredFields - New value of the property at index.

setIgnoredFields

public void setIgnoredFields(int[] ignoredFields)
Setter for property ignoredFields.

Parameters:
ignoredFields - New value of property ignoredFields.

getSavedField

public int getSavedField(int index)
Indexed getter for property savedFields.

Parameters:
index - Index of the property.
Returns:
Value of the property at index.

getSavedFields

public int[] getSavedFields()
Getter for property savedFields.

Returns:
Value of property savedFields.

setSavedField

public void setSavedField(int index,
                          int savedFields)
Indexed setter for property savedFields.

Parameters:
index - Index of the property.
savedFields - New value of the property at index.

setSavedFields

public void setSavedFields(int[] savedFields)
Setter for property savedFields.

Parameters:
savedFields - New value of property savedFields.

getKey

public int getKey(int index)
Indexed getter for property key.

Parameters:
index - Index of the property.
Returns:
Value of the property at index.

getKey

public int[] getKey()
Getter for property key.

Returns:
Value of property key.

setKey

public void setKey(int index,
                   int key)
Indexed setter for property key.

Parameters:
index - Index of the property.
key - New value of the property at index.

setKey

public void setKey(int[] key)
Setter for property key.

Parameters:
key - New value of property key.

getTimeout

public long getTimeout()
Getter for property timeout.

Returns:
Value of property timeout.

setTimeout

public void setTimeout(long timeout)
Setter for property timeout.

Parameters:
timeout - New value of property timeout.

isOverwriteOriginalFields

public boolean isOverwriteOriginalFields()
Getter for property overwriteOriginalFields.

Returns:
Value of property overwriteOriginalFields.

setOverwriteOriginalFields

public void setOverwriteOriginalFields(boolean overwriteOriginalFields)
Setter for property overwriteOriginalFields.

Parameters:
overwriteOriginalFields - New value of property overwriteOriginalFields.

jPOS.org