uk.org.iscream.cms.server.filter
Interface PluginFilter

All Known Implementing Classes:
EnforceEssentialData__Plugin, SourceChecker__Plugin, TypeChecker__Plugin

public interface PluginFilter

An interface to which a Plugin for a Filter must adhere.

Version:
$Id: PluginFilter.java,v 1.10 2004/08/01 10:40:59 tdb Exp $
Author:
$Author: tdb $

Method Summary
 String getDescription()
          Return a String representation of what the plugin filter does (e.g.
 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.
 

Method Detail

runFilter

public 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. return false otherwise.

Parameters:
packet - the packet to filter on
Returns:
whether the packet is allow to continue on

getDescription

public String getDescription()
Return a String representation of what the plugin filter does (e.g. "Rejects packets if x, y, and z")

Returns:
the description


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