uk.org.iscream.cms.server.filter
Class FilterMain

java.lang.Object
  extended byuk.org.iscream.cms.server.filter.FilterMain
All Implemented Interfaces:
Component

public class FilterMain
extends Object
implements Component

A Filter Startup Class A filter is an iscream component.

Version:
$Id: FilterMain.java,v 1.40 2004/08/01 10:40:58 tdb Exp $
Author:
$Author: tdb $

Field Summary
private  Logger _logger
          This holds a reference to the system logger that is being used.
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
FilterMain(String givenName)
          Constructs a Filter with the name given
 
Method Summary
 boolean depCheck()
          Does a dependency check.
 void start()
          Starts the Filter component
 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

_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

FilterMain

public FilterMain(String givenName)
Constructs a Filter with the name given

Parameters:
givenName - the name
Method Detail

start

public void start()
           throws ComponentStartException
Starts the Filter component

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

Returns:
the name of this class and its CVS revision


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