Package org.apache.catalina.startup

Class ListenerCreateRule.OptionalListener

java.lang.Object

org.apache.catalina.startup.ListenerCreateRule.OptionalListener

All Implemented Interfaces:

LifecycleListener

Enclosing class:

ListenerCreateRule

public static class ListenerCreateRule.OptionalListener
extends Object
implements LifecycleListener

A listener that is optional and may not be available at runtime.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	className	The class name of the listener.
protected final HashMap<String,String>	properties	The properties of the listener.

Constructor Summary

Constructors

Constructor	Description
OptionalListener(String className)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getClassName()	Return the class name of the listener.
Set<String>	getProperties()	Return a set of the property keys.
Object	getProperty(String name)	Return a property from the protocol handler.
void	lifecycleEvent(LifecycleEvent event)	Acknowledge the occurrence of the specified event.
boolean	setProperty(String name, String value)	Set the given property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

className

protected final String className

The class name of the listener.

properties

protected final HashMap<String,String> properties

The properties of the listener.

Constructor Details

OptionalListener

public OptionalListener(String className)

Constructor.

Parameters:

className - The class name of the listener

Method Details

getClassName

public String getClassName()

Return the class name of the listener.

Returns:

the className

lifecycleEvent

public void lifecycleEvent(LifecycleEvent event)

Description copied from interface: LifecycleListener

Acknowledge the occurrence of the specified event.

Specified by:

lifecycleEvent in interface LifecycleListener

Parameters:

event - LifecycleEvent that has occurred

getProperties

public Set<String> getProperties()

Return a set of the property keys.

Returns:

the set

getProperty

public Object getProperty(String name)

Return a property from the protocol handler.

Parameters:

name - the property name

Returns:

the property value

setProperty

public boolean setProperty(String name,
 String value)

Set the given property.

Parameters:

name - the property name

value - the property value

Returns:

true