net.sf.jradius.server.config
Class ConfigurationItem

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

Direct Known Subclasses:

DictionaryConfigurationItem, HandlerConfigurationItem, ListenerConfigurationItem, LogConfigurationItem

public abstract class ConfigurationItem
extends java.lang.Object

Base class for packet filter and listener configurations. This abstract class provides common methods for both configurations, since they are very similar in nature.

Author:

Gert Jan Verhoog, David Bird

See Also:

PacketHandlerConfigurationItem, ListenerConfigurationItem

Field Summary

protected java.lang.String	className
protected java.lang.String	description
protected XMLConfiguration	hcfg
protected java.lang.String	name
protected java.util.Map	properties
protected org.apache.commons.configuration.HierarchicalConfiguration.Node	root

Constructor Summary

ConfigurationItem(org.apache.commons.configuration.HierarchicalConfiguration.Node node, XMLConfiguration config)
Creates a new configuration item based on the options in the xml configuration file.

ConfigurationItem(java.lang.String name)

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

Method Summary

java.lang.String	getClassName()
java.lang.String	getDescription()
java.lang.String	getName()
java.util.Map	getProperties()
static java.util.HashMap	getPropertiesFromConfig(XMLConfiguration config, org.apache.commons.configuration.HierarchicalConfiguration.Node root)
org.apache.commons.configuration.HierarchicalConfiguration.Node	getRoot()
XMLConfiguration	getXMLConfig()
void	setClassName(java.lang.String className)
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)
void	setProperties(java.util.Map properties)
protected void	setProperties(XMLConfiguration config) Parse the <properties> element containing zero or more <key&
java.lang.String	toString()
java.lang.String	xmlKey()

Methods inherited from class java.lang.Object

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

Field Detail

hcfg

protected XMLConfiguration hcfg

root

protected org.apache.commons.configuration.HierarchicalConfiguration.Node root

name

protected java.lang.String name

description

protected java.lang.String description

className

protected java.lang.String className

properties

protected java.util.Map properties

Constructor Detail

ConfigurationItem

public ConfigurationItem(java.lang.String name)

ConfigurationItem

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

ConfigurationItem

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

Creates a new configuration item based on the options in the xml configuration file. The configuration item is created from the xml element in HierarchicalConfiguration config at index index.

Parameters:

node - the current configuration node being examined

config - the configuration

Method Detail

setProperties

protected void setProperties(XMLConfiguration config)

Parse the <properties> element containing zero or more <key&

Parameters:

config -

getPropertiesFromConfig

public static java.util.HashMap getPropertiesFromConfig(XMLConfiguration config,
                                                        org.apache.commons.configuration.HierarchicalConfiguration.Node root)

getClassName

public java.lang.String getClassName()

getDescription

public java.lang.String getDescription()

getName

public java.lang.String getName()

getProperties

public java.util.Map getProperties()

getXMLConfig

public XMLConfiguration getXMLConfig()

getRoot

public org.apache.commons.configuration.HierarchicalConfiguration.Node getRoot()

setClassName

public void setClassName(java.lang.String className)

Parameters:

className - The className to set.

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - The description to set.

setName

public void setName(java.lang.String name)

Parameters:

name - The name to set.

setProperties

public void setProperties(java.util.Map properties)

Parameters:

properties - The properties to set.

xmlKey

public java.lang.String xmlKey()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object