net.sf.jradius.server.config
Class HandlerConfigurationItem

java.lang.Object
  net.sf.jradius.server.config.ConfigurationItem
      net.sf.jradius.server.config.HandlerConfigurationItem

Direct Known Subclasses:

PacketHandlerConfigurationItem

public class HandlerConfigurationItem
extends ConfigurationItem

Configuration Item for Event Handlers.

Author:

Gert Jan Verhoog, David Bird

Field Summary

static java.lang.String	CATALOG_KEY
static java.lang.String	HANDLER_KEY
static java.lang.String	SENDER_KEY
static java.lang.String	TYPE_KEY
static java.lang.String	XML_KEY
static java.lang.String	XML_LIST_KEY

Fields inherited from class net.sf.jradius.server.config.ConfigurationItem

className, description, hcfg, name, properties, root

Constructor Summary

HandlerConfigurationItem(org.apache.commons.configuration.HierarchicalConfiguration.Node node, XMLConfiguration config)

HandlerConfigurationItem(java.lang.String name)

HandlerConfigurationItem(java.lang.String name, java.lang.String className)

Method Summary

java.lang.String	getCatalogName()
java.lang.String	getHandlerName()
java.util.Collection	getHandleTypes()
java.util.Collection	getPossibleTypes()
java.util.Collection	getSenders()
boolean	handlesSender(java.lang.Object sender)
boolean	handlesType(java.lang.String type)
void	setCatalogName(java.lang.String catalogName)
void	setHandlerName(java.lang.String handlerName)
void	setHandleTypes(java.util.Collection handleTypes)
void	setHandleTypes(java.lang.String handleTypes)
void	setPossibleTypes(java.util.Collection possibleTypes)
void	setSenders(java.util.Collection senders)
void	setSenders(java.lang.String sender)

Methods inherited from class net.sf.jradius.server.config.ConfigurationItem

getClassName, getDescription, getName, getProperties, getPropertiesFromConfig, getRoot, getXMLConfig, setClassName, setDescription, setName, setProperties, setProperties, toString, xmlKey

Methods inherited from class java.lang.Object

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

Field Detail

XML_LIST_KEY

public static final java.lang.String XML_LIST_KEY

See Also:

Constant Field Values

XML_KEY

public static final java.lang.String XML_KEY

See Also:

Constant Field Values

TYPE_KEY

public static final java.lang.String TYPE_KEY

See Also:

Constant Field Values

SENDER_KEY

public static final java.lang.String SENDER_KEY

See Also:

Constant Field Values

HANDLER_KEY

public static final java.lang.String HANDLER_KEY

See Also:

Constant Field Values

CATALOG_KEY

public static final java.lang.String CATALOG_KEY

See Also:

Constant Field Values

Constructor Detail

HandlerConfigurationItem

public HandlerConfigurationItem(java.lang.String name)

HandlerConfigurationItem

public HandlerConfigurationItem(java.lang.String name,
                                java.lang.String className)

HandlerConfigurationItem

public HandlerConfigurationItem(org.apache.commons.configuration.HierarchicalConfiguration.Node node,
                                XMLConfiguration config)

Method Detail

getHandleTypes

public java.util.Collection getHandleTypes()

Returns:

Returns the handled types

setHandleTypes

public void setHandleTypes(java.util.Collection handleTypes)

Parameters:

handleTypes - The handled types to set.

setHandleTypes

public void setHandleTypes(java.lang.String handleTypes)

Parameters:

handleTypes - The handled types to set.

setSenders

public void setSenders(java.lang.String sender)

Parameters:

sender - The requester name(s) allowed for this handler.

getSenders

public java.util.Collection getSenders()

Returns:

Returns the list of requesters serviced by this handler

getPossibleTypes

public java.util.Collection getPossibleTypes()

Returns:

Returns the possible types to handle.

setPossibleTypes

public void setPossibleTypes(java.util.Collection possibleTypes)

Parameters:

possibleTypes - The possible types to set.

handlesType

public boolean handlesType(java.lang.String type)

handlesSender

public boolean handlesSender(java.lang.Object sender)

getCatalogName

public java.lang.String getCatalogName()

Returns:

Returns the catalogName.

setCatalogName

public void setCatalogName(java.lang.String catalogName)

Parameters:

catalogName - The catalogName to set.

getHandlerName

public java.lang.String getHandlerName()

Returns:

Returns the handlerName.

setHandlerName

public void setHandlerName(java.lang.String handlerName)

Parameters:

handlerName - The handlerName to set.

setSenders

public void setSenders(java.util.Collection senders)

Parameters:

senders - The senders to set.