uk.org.iscream.cms.server.filter.plugins
Class TypeChecker__Plugin

java.lang.Object
  extended byuk.org.iscream.cms.server.filter.plugins.TypeChecker__Plugin
All Implemented Interfaces:
PluginFilter

public class TypeChecker__Plugin
extends Object
implements PluginFilter

This plugin is designed to check the type of incoming packets.

Version:
$Id: TypeChecker__Plugin.java,v 1.10 2004/08/01 10:41:02 tdb Exp $
Author:
$Author: tdb $

Field Summary
private  Logger _logger
          This holds a reference to the system logger that is being used.
private  String _name
          This is the friendly identifier of the component this class is running in.
 String DESC
           
 String REVISION
          The current CVS revision of this class
 
Constructor Summary
TypeChecker__Plugin()
           
 
Method Summary
 String getDescription()
          return the String representation of what the filter does
 boolean runFilter(XMLPacket packet)
          Return true if the filter wishes to allow the XMLPacket to pass to the next stage of the plugin filter pipeline.
 String toString()
          Overrides the Object.toString() method to provide clean logging (every class should have this).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

REVISION

public final String REVISION
The current CVS revision of this class

See Also:
Constant Field Values

DESC

public final String DESC
See Also:
Constant Field Values

_name

private String _name
This is the friendly identifier of the component this class is running in. eg, a Filter may be called "filter1", If this class does not have an owning component, a name from the configuration can be placed here. This name could also be changed to null for utility classes.


_logger

private Logger _logger
This holds a reference to the system logger that is being used.

Constructor Detail

TypeChecker__Plugin

public TypeChecker__Plugin()
Method Detail

runFilter

public boolean runFilter(XMLPacket packet)
Description copied from interface: PluginFilter
Return true if the filter wishes to allow the XMLPacket to pass to the next stage of the plugin filter pipeline. return false otherwise.

Specified by:
runFilter in interface PluginFilter
Parameters:
packet - the packet to filter on
Returns:
whether the packet is allow to continue on

toString

public String toString()
Overrides the Object.toString() method to provide clean logging (every class should have this). This uses the uk.org.iscream.cms.util.NameFormat class to format the toString()

Returns:
the name of this class and its CVS revision

getDescription

public String getDescription()
return the String representation of what the filter does

Specified by:
getDescription in interface PluginFilter
Returns:
the description


Copyright © 2000-2003 i-scream. All Rights Reserved.