com.jalios.jcms
Class ChannelListener

java.lang.Object
  extended by com.jalios.jcms.ChannelListener
All Implemented Interfaces:
PluginComponent, Comparable
Direct Known Subclasses:
AccessControlManager, DerbyManager, FileProcessorManager

public abstract class ChannelListener
extends Object
implements Comparable, PluginComponent

A listener called during the Channel life cycle.

Since:
jcms-2.1
Version:
$Revision: 28011 $
Author:
Olivier Dedieu

Field Summary
protected  int order
           
static String REVISION
           
 
Constructor Summary
ChannelListener()
          Constructs a ChannelListener with order = 0
ChannelListener(int order)
          Constructs a ChannelListener with the given order
 
Method Summary
 int compareTo(Object obj)
          Compare this object with the specified object for order.
 boolean equals(Object obj)
          Indicates wheter some other object is "equal to" this one.
abstract  void handleFinalize()
          Called when the channel is finalized
 boolean init(Plugin plugin)
          Initialize the component with the given plugin configuration
abstract  void initAfterStoreLoad()
          Called just after the store has been loaded and the channel has been initialized.
abstract  void initBeforeStoreLoad()
          Called just before the store has been loaded.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

order

protected int order
Constructor Detail

ChannelListener

public ChannelListener()
Constructs a ChannelListener with order = 0

Since:
jcms-5.0.0

ChannelListener

public ChannelListener(int order)
Constructs a ChannelListener with the given order

Parameters:
order - the order
Since:
jcms-5.5.0
Method Detail

compareTo

public int compareTo(Object obj)
Compare this object with the specified object for order.

Specified by:
compareTo in interface Comparable
Parameters:
obj - the Object to be compared.
See Also:
Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)
Indicates wheter some other object is "equal to" this one. The comparison is performed with compareTo() method.

Overrides:
equals in class Object
Parameters:
obj - the Object to be compared.

init

public boolean init(Plugin plugin)
Description copied from interface: PluginComponent
Initialize the component with the given plugin configuration

Specified by:
init in interface PluginComponent
Parameters:
plugin - the calling plugin
Returns:
true if the component has been correctly initialized.

handleFinalize

public abstract void handleFinalize()
Called when the channel is finalized

Since:
jcms-2.1

initBeforeStoreLoad

public abstract void initBeforeStoreLoad()
                                  throws Exception
Called just before the store has been loaded. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).

Throws:
Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.
Since:
jcms-5.7.0

initAfterStoreLoad

public abstract void initAfterStoreLoad()
                                 throws Exception
Called just after the store has been loaded and the channel has been initialized. If for any reason you want to interrupt JCMS startup, you can throw an exception. The exception's message will be displayed in JCMS status page (to any user!).

Throws:
Exception - any exception you may want to throw if a problem occurs needing to interrupt JCMS startup.
Since:
jcms-5.7.0


Copyright © 2001-2010 Jalios SA. All Rights Reserved.