uk.org.iscream.cms.server.filtermanager
Class FilterManager

java.lang.Object
  extended by uk.org.iscream.cms.server.filtermanager.FilterManager
All Implemented Interfaces:
Component

public class FilterManager
extends Object
implements Component

The FilterManager handles initialisation of hosts with the system, allowing hosts to gain their configuration and a hook to a Filter to talk to.

Version:
$Id: FilterManager.java,v 1.28 2004/08/01 10:41:05 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.
private  ReferenceManager _refman
          A reference to the reference manager in use
static String NAME
          The friendly name for this component, used by all related classes.
static String REVISION
          The current CVS revision of this class
 
Constructor Summary
FilterManager(String givenName)
          Constructs a FilterManager with the name given
 
Method Summary
 boolean depCheck()
          Does a dependency check.
 void start()
          This method starts the FilterManager
 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 static final String REVISION
The current CVS revision of this class

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.


_refman

private ReferenceManager _refman
A reference to the reference manager in use


NAME

public static String NAME
The friendly name for this component, used by all related classes. This is set from the configuration.

Constructor Detail

FilterManager

public FilterManager(String givenName)
Constructs a FilterManager with the name given

Parameters:
givenName - the name
Method Detail

start

public void start()
           throws ComponentStartException
This method starts the FilterManager

Specified by:
start in interface Component
Throws:
ComponentStartException

depCheck

public boolean depCheck()
Does a dependency check. Used mainly at startup to see if the required dependencies (components) are up and running.

Specified by:
depCheck in interface Component
Returns:
a boolean value, true if the depdencies are satisfied

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()

Overrides:
toString in class Object
Returns:
the name of this class and its CVS revision


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