org.apache.manifoldcf.core.interfaces

Class ManifoldCFConfiguration

java.lang.Object

org.apache.manifoldcf.core.interfaces.Configuration

org.apache.manifoldcf.core.interfaces.ManifoldCFConfiguration

All Implemented Interfaces:

IHierarchyParent

Direct Known Subclasses:

ManifoldCF.OverrideableManifoldCFConfiguration

public class ManifoldCFConfiguration
extends Configuration

This class represents the configuration data read from the main ManifoldCF configuration XML file.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.manifoldcf.core.interfaces.Configuration

Configuration.JSONReader, Configuration.JSONWriter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid
static java.lang.String	ATTRIBUTE_NAME
static java.lang.String	ATTRIBUTE_VALUE
protected java.util.Map<java.lang.String,java.lang.String>	localProperties
static java.lang.String	NODE_PROPERTY

Fields inherited from class org.apache.manifoldcf.core.interfaces.Configuration

children, JSON_ATTRIBUTE, JSON_CHILDREN, JSON_TYPE, JSON_VALUE, readOnly, rootNodeLabel

Constructor Summary

Constructors

Constructor and Description
ManifoldCFConfiguration() Constructor.
ManifoldCFConfiguration(java.io.InputStream xmlStream) Construct from XML.

Method Summary

Modifier and Type	Method and Description
protected Configuration	createNew() Create a new object of the appropriate class.
void	fromXML(java.io.InputStream is) Read from an input stream.
boolean	getBooleanProperty(java.lang.String s, boolean defaultValue) Read a boolean property
double	getDoubleProperty(java.lang.String s, double defaultValue) Read a float property, either from the system properties, or from the local configuration file.
int	getIntProperty(java.lang.String s, int defaultValue) Read an integer property, either from the system properties, or from the local configuration file.
long	getLongProperty(java.lang.String s, long defaultValue) Read a long property, either from the system properties, or from the local configuration file.
java.lang.String	getPossiblyObfuscatedStringProperty(java.lang.String s, java.lang.String defaultValue) Read a possibly obfuscated string property, either from the system properties, or from the local configuration file.
java.lang.String	getProperty(java.lang.String s)
java.lang.String	getStringProperty(java.lang.String s, java.lang.String defaultValue) Read a (string) property, either from the system properties, or from the local configuration file.
protected void	parseProperties()

Methods inherited from class org.apache.manifoldcf.core.interfaces.Configuration

addChild, addOuterNode, clearChildren, clearOuterNodes, createDuplicate, createNewNode, equals, findChild, fromJSON, fromXML, getChildCount, hashCode, initializeFromDoc, makeReadOnly, processObject, processObject, readNode, readNode, removeChild, removeOuterNode, toJSON, toString, toXML, writeNode, writeNode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

NODE_PROPERTY

public static final java.lang.String NODE_PROPERTY

See Also:

Constant Field Values

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

See Also:

Constant Field Values

ATTRIBUTE_VALUE

public static final java.lang.String ATTRIBUTE_VALUE

See Also:

Constant Field Values

localProperties

protected final java.util.Map<java.lang.String,java.lang.String> localProperties

Constructor Detail

ManifoldCFConfiguration

public ManifoldCFConfiguration()

Constructor.

ManifoldCFConfiguration

public ManifoldCFConfiguration(java.io.InputStream xmlStream)
                        throws ManifoldCFException

Construct from XML.

Parameters:

xmlStream - is the input XML stream.

Throws:

ManifoldCFException

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String s)

getStringProperty

public java.lang.String getStringProperty(java.lang.String s,
                                          java.lang.String defaultValue)

Read a (string) property, either from the system properties, or from the local configuration file.

Parameters:

s - is the property name.

defaultValue - is the default value for the property.

Returns:

the property value, as a string.

getPossiblyObfuscatedStringProperty

public java.lang.String getPossiblyObfuscatedStringProperty(java.lang.String s,
                                                            java.lang.String defaultValue)
                                                     throws ManifoldCFException

Read a possibly obfuscated string property, either from the system properties, or from the local configuration file.

Parameters:

s - is the property name.

defaultValue - is the default value for the property.

Returns:

the property value, as a string.

Throws:

ManifoldCFException

getBooleanProperty

public boolean getBooleanProperty(java.lang.String s,
                                  boolean defaultValue)
                           throws ManifoldCFException

Read a boolean property

Throws:

ManifoldCFException

getIntProperty

public int getIntProperty(java.lang.String s,
                          int defaultValue)
                   throws ManifoldCFException

Read an integer property, either from the system properties, or from the local configuration file.

Throws:

ManifoldCFException

getLongProperty

public long getLongProperty(java.lang.String s,
                            long defaultValue)
                     throws ManifoldCFException

Read a long property, either from the system properties, or from the local configuration file.

Throws:

ManifoldCFException

getDoubleProperty

public double getDoubleProperty(java.lang.String s,
                                double defaultValue)
                         throws ManifoldCFException

Read a float property, either from the system properties, or from the local configuration file.

Throws:

ManifoldCFException

parseProperties

protected void parseProperties()
                        throws ManifoldCFException

Throws:

ManifoldCFException

fromXML

public void fromXML(java.io.InputStream is)
             throws ManifoldCFException

Read from an input stream.

Overrides:

fromXML in class Configuration

Parameters:

is - is the input XML stream. Does NOT close the stream.

Throws:

ManifoldCFException

createNew

protected Configuration createNew()

Create a new object of the appropriate class.

Overrides:

createNew in class Configuration

Returns:

the newly-created configuration object.