com.sibvisions.rad.server.config
Class ApplicationZone

java.lang.Object
  com.sibvisions.rad.server.config.UpToDateConfigFile
      com.sibvisions.rad.server.config.Zone
          com.sibvisions.rad.server.config.ApplicationZone

All Implemented Interfaces:

java.lang.Cloneable

public final class ApplicationZone
extends Zone

The ApplicationZone class encapsulates the access to an application configuration.

Method Summary

java.lang.Object	clone()
java.lang.String	getName() Returns the name of the application.
XmlNode	getNode(java.lang.String pName) Gets the xml node for a property name from the application configuration.
java.util.List<XmlNode>	getNodes(java.lang.String pName) Gets the xml node or a list of nodes for a property name from the application configuration.
java.util.List<java.lang.String>	getProperties(java.lang.String pName) Gets a list of values for a property which exists more than once.
java.lang.String	getProperty(java.lang.String pName, java.lang.String pDefault) Gets the value of a property from the application configuration file.
ServerZone	getServerZone() Gets the current server zone.
void	setUpdateEnabled(boolean pEnabled) Sets whether this application zone should be up-to-date.

Methods inherited from class com.sibvisions.rad.server.config.Zone

addEncryptedNode, createXmlWorker, getConfig, getDirectory, isValid, isValid, removeEncryptedNode

Methods inherited from class com.sibvisions.rad.server.config.UpToDateConfigFile

getFile, getProperty, isCloneNodes, isFile, isSaveImmediate, isStream, isUpdateEnabled, isValid, isVirtual, prepareIncludeNodes, reload, replacePlaceholder, replacePlaceholder, save, setCloneNodes, setContent, setNode, setProperty, setSaveImmediate, update

Methods inherited from class java.lang.Object

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

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class UpToDateConfigFile

Throws:

java.lang.CloneNotSupportedException

getProperty

public java.lang.String getProperty(java.lang.String pName,
                                    java.lang.String pDefault)
                             throws java.lang.Exception

Gets the value of a property from the application configuration file. If the property was not found then the property will be read from the server configuration file.

Overrides:

getProperty in class UpToDateConfigFile

Parameters:

pName - the property name (e.g /application/securitymanager/class)

pDefault - the default value if the property is not available in the application and server configuration

Returns:

the value for the property or pDefault if the property is generally not available

Throws:

java.lang.Exception - if the configuration(s) is/are invalid

getProperties

public java.util.List<java.lang.String> getProperties(java.lang.String pName)
                                               throws java.lang.Exception

Gets a list of values for a property which exists more than once. The list will be extended with not already containing server properties.

Overrides:

getProperties in class UpToDateConfigFile

Parameters:

pName - the property name

Returns:

the list of merged values from the application and server configuration or null if the property is generally not available

Throws:

java.lang.Exception - if the configuration is invalid

getNodes

public java.util.List<XmlNode> getNodes(java.lang.String pName)
                                 throws java.lang.Exception

Gets the xml node or a list of nodes for a property name from the application configuration. The list will be extended if the server configuration contains the same property. The list first contains the server nodes and then the application nodes.

Overrides:

getNodes in class UpToDateConfigFile

Parameters:

pName - the property name

Returns:

the available xml node(s) from the application and server configuration or null if the property is generally not available

Throws:

java.lang.Exception - if the configuration(s) is/are invalid

getNode

public XmlNode getNode(java.lang.String pName)
                throws java.lang.Exception

Gets the xml node for a property name from the application configuration. If the property was not found in the application configuration, then the server configuration will be used.

Overrides:

getNode in class UpToDateConfigFile

Parameters:

pName - the property name

Returns:

the available xml node from the application or server configuration or null if the property is generally not available

Throws:

java.lang.Exception - if the configuration(s) is/are invalid

setUpdateEnabled

public void setUpdateEnabled(boolean pEnabled)

Sets whether this application zone should be up-to-date.

Overrides:

setUpdateEnabled in class UpToDateConfigFile

Parameters:

pEnabled - true to disable up-to-date configuration properties. This disables the up-to-date option of the server zone too (@see getServerZone().

getName

public java.lang.String getName()

Returns the name of the application.

Returns:

the application name

getServerZone

public ServerZone getServerZone()

Gets the current server zone. If up-to-date option is disabled, then an frozen copy of the server zone will be returned.

Returns:

the zone of the server or null if the zone has errors

See Also:

ServerZone, setUpdateEnabled(boolean)