net.jradius.server.config

Class ConfigurationItem

java.lang.Object

net.jradius.server.config.ConfigurationItem

Direct Known Subclasses:

DictionaryConfigurationItem, HandlerConfigurationItem, ListenerConfigurationItem, LogConfigurationItem

public abstract class ConfigurationItem
extends 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

Fields

Modifier and Type	Field and Description
protected String	className
protected String	description
protected XMLConfiguration	hcfg
protected String	name
protected Map<String,String>	properties
protected org.apache.commons.configuration.HierarchicalConfiguration.Node	root

Constructor Summary

Constructors

Constructor and Description
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(String name)
ConfigurationItem(String name, String className)

Method Summary

Modifier and Type	Method and Description
String	getClassName()
String	getDescription()
String	getName()
Map<String,String>	getProperties()
static HashMap<String,String>	getPropertiesFromConfig(XMLConfiguration config, org.apache.commons.configuration.HierarchicalConfiguration.Node root)
org.apache.commons.configuration.HierarchicalConfiguration.Node	getRoot()
XMLConfiguration	getXMLConfig()
void	setClassName(String className)
void	setDescription(String description)
void	setName(String name)
void	setProperties(Map<String,String> properties)
protected void	setProperties(XMLConfiguration config) Parse the <properties> element containing zero or more <key&
String	toString()
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 String name

description

protected String description

className

protected String className

properties

protected Map<String,String> properties

Constructor Detail

ConfigurationItem

public ConfigurationItem(String name)

ConfigurationItem

public ConfigurationItem(String name,
                         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 HashMap<String,String> getPropertiesFromConfig(XMLConfiguration config,
                                                             org.apache.commons.configuration.HierarchicalConfiguration.Node root)

getClassName

public String getClassName()

getDescription

public String getDescription()

getName

public String getName()

getProperties

public Map<String,String> getProperties()

getXMLConfig

public XMLConfiguration getXMLConfig()

getRoot

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

setClassName

public void setClassName(String className)

Parameters:

className - The className to set.

setDescription

public void setDescription(String description)

Parameters:

description - The description to set.

setName

public void setName(String name)

Parameters:

name - The name to set.

setProperties

public void setProperties(Map<String,String> properties)

Parameters:

properties - The properties to set.

xmlKey

public String xmlKey()

toString

public String toString()

Overrides:

toString in class Object