com.novell.nds.dirxml.shimhost

Class OldStyleParams

java.lang.Object

com.novell.nds.dirxml.shimhost.OldStyleParams

All Implemented Interfaces:

ConfigElement

public class OldStyleParams
extends java.lang.Object
implements ConfigElement

Class encapsulating "old-style" DirXML shim parameters (i.e., pre-GCV-style parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OldStyleParams.Param Encapsulation of a single shim parameter.
static class	OldStyleParams.PasswordParam Encapsulation of a "password-ref" shim parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_DISPLAY_NAME Name of the XML 'display-name' attribute.
static java.lang.String	ATTR_TYPE Name of the XML 'type' attribute.
static java.lang.String	VAL_PASSWORD_REF "password-ref"

Constructor Summary

Constructors

Constructor and Description
OldStyleParams() Create an empty OldStyleParams instance.
OldStyleParams(org.w3c.dom.Node parent) Create an OldStyleParams instance from an XML representation.

Method Summary

Modifier and Type	Method and Description
void	addParam(OldStyleParams.Param param) Add an old-style shim parameter to this instance.
OldStyleParams.Param	getParam(java.lang.String paramName) Get a shim parameter from this instance by name.
boolean	hasBeenModified() Return true if this instance has been modified.
java.util.Iterator	iterator() Get an Iterator that will return all the Param instances in this OldStyleParams instance.
void	removeParam(java.lang.String paramName) Remove a shim parameter from this instance.
void	resetModified() Reset the modified flag for this instance such that hasBeenModified() will return false.
org.w3c.dom.Element	toXML(org.w3c.dom.Node parent) Create an XML representation of the shim parameters encapsulated in this instance.

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_DISPLAY_NAME

public static final java.lang.String ATTR_DISPLAY_NAME

Name of the XML 'display-name' attribute.

See Also:

Constant Field Values

ATTR_TYPE

public static final java.lang.String ATTR_TYPE

Name of the XML 'type' attribute.

See Also:

Constant Field Values

VAL_PASSWORD_REF

public static final java.lang.String VAL_PASSWORD_REF

"password-ref"

See Also:

Constant Field Values

Constructor Detail

OldStyleParams

public OldStyleParams()

Create an empty OldStyleParams instance.

OldStyleParams

public OldStyleParams(org.w3c.dom.Node parent)

Create an OldStyleParams instance from an XML representation.

Parameters:

parent - Node containing the parameter elements (typically <driver-options>, <subscriber-options>, or <publisher-options>

Method Detail

hasBeenModified

public boolean hasBeenModified()

Return true if this instance has been modified.

The instance is considered to have been modified if a change was made that affects the persistent representation since:

1. The instance was constructed from an XML representation.
2. resetModified() was last called

Specified by:

hasBeenModified in interface ConfigElement

Returns:

true or false

See Also:

resetModified(), toXML(org.w3c.dom.Node)

resetModified

public void resetModified()

Reset the modified flag for this instance such that hasBeenModified() will return false.

Specified by:

resetModified in interface ConfigElement

See Also:

hasBeenModified()

addParam

public void addParam(OldStyleParams.Param param)

Add an old-style shim parameter to this instance.

Parameters:

param - Param instance to add

removeParam

public void removeParam(java.lang.String paramName)

Remove a shim parameter from this instance. This will remove the first parameter matching the passed name, but there may be others with the same name remaining.

Parameters:

paramName - name of parameter

getParam

public OldStyleParams.Param getParam(java.lang.String paramName)

Get a shim parameter from this instance by name. This will return the first parameter matching the passed name, but there may also be additional parameters with the same name.

Parameters:

paramName - name of parameter

Returns:

Param instance or null, if no parameter has the passed name

iterator

public java.util.Iterator iterator()

Get an Iterator that will return all the Param instances in this OldStyleParams instance.

Returns:

Iterator

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Node parent)

Create an XML representation of the shim parameters encapsulated in this instance.

Note that the act of creating an XML representation does not reset this instance's modified flag. It must be reset by calling resetModified().

Specified by:

toXML in interface ConfigElement

Parameters:

parent - Node under which to construct XML representation

Returns:

first created Element

See Also:

hasBeenModified(), resetModified()