com.netegrity.sdk.policyapi
Class SmRootConfig

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmRootConfig

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public class SmRootConfig
extends SmObjectImpl

Represents a SiteMinder Root Configuration object.

Root Configuration objects do not have a name or a description.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropDynamicPrefs Constant to indicate the property Dynamic Preferences.
static java.lang.String	PropEnableUserTracking Constant to indicate the property Enable User Tracking.
static java.lang.String	PropKeyStoreVersion Constant to indicate the Keystore Version property.
static java.lang.String	PropMajorVersion Constant to indicate the Major Version property .
static java.lang.String	PropMinorVersion Constant to indicate the Minor Version property.
static java.lang.String	PropMode Constant to indicate the mode property.
static java.lang.String	PropRootConfig Property name to be specified in the method getGlobalObjectNames().

Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmRootConfig()
Constructs a SiteMinder Root Configuration object.

SmRootConfig(java.lang.String oid)
Constructs a Root Configuration object with the specified Object identifier.

Method Summary

boolean	getADEnhanced() Gets the ADEnhanced setting.
java.lang.String	getDescription() Returns null for Root Configuration objects.
java.lang.String	getDynamicPrefs() Gets the dynamic preferences for the object.
boolean	getEnableUserTracking() Gets the Enable User Tracking setting.
int	getKeystoreVersion() Gets the Keystore Version value.
int	getMinorVersion() Gets the Minor Version value.
int	getMode() Gets the Mode value.
java.lang.String	getName() Returns null for Root Configuration objects.
boolean	getNestedSecurity() Gets the Nested security setting.
int	getVersion() Gets the Major Version value.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setADEnhanced(boolean bADEnhanced) Sets the ADEnhanced setting.
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setDynamicPrefs(java.lang.String dynamicPrefs) Sets dynamic preferences for the object.
void	setEnableUserTracking(boolean enableUserTracking) Sets the Enable User Tracking setting.
void	setKeystoreVersion(int nKeystoreVersion) Sets the Keystore Version value.
void	setMajorVersion(int nMajorVersion) Sets the Major Version value.
void	setMinorVersion(int nMinorVersion) Sets the Minor Version value.
void	setMode(int nMode) Sets the Mode value.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setNestedSecurity(boolean bNestedSecurity) Sets the Nested security setting
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

getObjectClassname, getOid, isDomainObject, isWriteable, newObject, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PropRootConfig

public static final java.lang.String PropRootConfig

Property name to be specified in the method getGlobalObjectNames().

See Also:

Constant Field Values

PropEnableUserTracking

public static final java.lang.String PropEnableUserTracking

Constant to indicate the property Enable User Tracking.

See Also:

Constant Field Values

PropDynamicPrefs

public static final java.lang.String PropDynamicPrefs

Constant to indicate the property Dynamic Preferences.

See Also:

Constant Field Values

PropMajorVersion

public static final java.lang.String PropMajorVersion

Constant to indicate the Major Version property .

See Also:

Constant Field Values

PropMinorVersion

public static final java.lang.String PropMinorVersion

Constant to indicate the Minor Version property.

See Also:

Constant Field Values

PropMode

public static final java.lang.String PropMode

Constant to indicate the mode property.

See Also:

Constant Field Values

PropKeyStoreVersion

public static final java.lang.String PropKeyStoreVersion

Constant to indicate the Keystore Version property.

See Also:

Constant Field Values

Constructor Detail

SmRootConfig

public SmRootConfig()

Constructs a SiteMinder Root Configuration object. The name and description of the Root Config are not set with this constructor.

SmRootConfig

public SmRootConfig(java.lang.String oid)

Constructs a Root Configuration object with the specified Object identifier.

Parameters:

oid - Object identifier for the root configuration object.

Method Detail

getName

public java.lang.String getName()

Returns null for Root Configuration objects. These objects don't have a name property.

Specified by:

getName in interface SmObject

Overrides:

getName in class SmObjectImpl

Returns:

null.

setName

public void setName(java.lang.String name)

Sets the name of the object to null. Root Configuration objects don't have a name property.

Specified by:

setName in interface SmObject

Overrides:

setName in class SmObjectImpl

Parameters:

name - The name of the object.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the object to null. Root Configuration objects don't have a description property.

Specified by:

setDescription in interface SmObject

Overrides:

setDescription in class SmObjectImpl

Parameters:

name - The description of the object.

getDescription

public java.lang.String getDescription()

Returns null for Root Configuration objects. These objects don't have a name property.

Specified by:

getDescription in interface SmObject

Overrides:

getDescription in class SmObjectImpl

Returns:

null.

getDynamicPrefs

public java.lang.String getDynamicPrefs()

Gets the dynamic preferences for the object.

Returns:

The dynamic preferences.

setDynamicPrefs

public void setDynamicPrefs(java.lang.String dynamicPrefs)

Sets dynamic preferences for the object.

Parameters:

dynamicPrefs - The dynamic preferences.

getEnableUserTracking

public boolean getEnableUserTracking()

Gets the Enable User Tracking setting.

Returns:

The Enable User Tracking setting.

setEnableUserTracking

public void setEnableUserTracking(boolean enableUserTracking)

Sets the Enable User Tracking setting.

Parameters:

enableUserTracking - true if user tracking is enabled. false otherwise.

setNestedSecurity

public void setNestedSecurity(boolean bNestedSecurity)

Sets the Nested security setting

Parameters:

bNestedSecurity - true if Nested Security is enabled. false otherwise.

getNestedSecurity

public boolean getNestedSecurity()

Gets the Nested security setting.

Parameters:

Returns - true if Nested Security is enabled otherwise false.

setADEnhanced

public void setADEnhanced(boolean bADEnhanced)

Sets the ADEnhanced setting.

Parameters:

bADEnhanced - true if ADEnhanced is enabled. false otherwise.

getADEnhanced

public boolean getADEnhanced()

Gets the ADEnhanced setting.

Parameters:

Returns - true if ADEnhanced is enabled otherwise false.

getVersion

public int getVersion()

Gets the Major Version value.

Returns:

The Major Version.

setMajorVersion

public void setMajorVersion(int nMajorVersion)

Sets the Major Version value.

Parameters:

Major - Version as int value.

getMinorVersion

public int getMinorVersion()

Gets the Minor Version value.

Returns:

The Minor Version.

setMinorVersion

public void setMinorVersion(int nMinorVersion)

Sets the Minor Version value.

Parameters:

Minor - Version as int value.

getMode

public int getMode()

Gets the Mode value.

Returns:

The Mode value.

setMode

public void setMode(int nMode)

Sets the Mode value.

Parameters:

Mode - as int value.

getKeystoreVersion

public int getKeystoreVersion()

Gets the Keystore Version value.

Returns:

The Keystore Version.

setKeystoreVersion

public void setKeystoreVersion(int nKeystoreVersion)

Sets the Keystore Version value.

Parameters:

Keystore - Version as int value.

writeProperties

public void writeProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties to the specified hashtable.

Specified by:

writeProperties in interface SmObject

Overrides:

writeProperties in class SmObjectImpl

Parameters:

properties - The hashtable where the object properties will be copied.

readProperties

public void readProperties(java.util.Hashtable properties)

Description copied from interface: SmObject

Copies the object properties from the specified hashtable.

Specified by:

readProperties in interface SmObject

Overrides:

readProperties in class SmObjectImpl

Parameters:

properties - The new properties of the object.