com.netegrity.sdk.policyapi
Class SmSharedSecretPolicy

java.lang.Object
  |
  +--com.netegrity.sdk.policyapi.SmObjectImpl
        |
        +--com.netegrity.sdk.policyapi.SmSharedSecretPolicy

All Implemented Interfaces:

java.lang.Cloneable, SmObject

public final class SmSharedSecretPolicy

extends SmObjectImpl

Represents a SiteMinder Shared Secret Policy object.

Shared Secret Policy objects do not have a name or a description.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropIsEnabled Constant to indicate the property Enabled.
static java.lang.String	PropRolloverFrequency Constant to indicate the property Roll over Frequency.
static java.lang.String	PropRolloverPeriod Constant to indicate the property Roll Over Period.
static java.lang.String	PropSharedSecretPolicy 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

SmSharedSecretPolicy()
Constructs a SiteMinder Shared Secret Policy object.

SmSharedSecretPolicy(java.lang.String oid)
Constructs a Shared Secret Policy object with the specified Object identifier.

Method Summary

java.lang.String	getDescription() Returns null for Shared Secret Policy objects.
boolean	getIsEnabled() Gets the Enabled state of Shared Secret Policy object.
java.lang.String	getName() Returns null for Shared Secret Policy objects.
int	getRolloverFrequency() Gets the Roll Over Frequency for Shared Secret Policy Object
int	getRolloverPeriod() Gets the Roll Over Period for Shared Secret Policy Object
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setIsEnabled(boolean bIsEnabled) Sets the Enabled state of Shared Secret Policy object.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setRolloverFrequency(int nRolloverFrequency) Sets the Roll Over Frequency for Shared Secret Policy Object
void	setRolloverPeriod(int nRolloverPeriod) Sets the Roll Over Period for Shared Secret Policy Object
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

PropSharedSecretPolicy

public static final java.lang.String PropSharedSecretPolicy

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

See Also:

Constant Field Values

PropIsEnabled

public static final java.lang.String PropIsEnabled

Constant to indicate the property Enabled.

See Also:

Constant Field Values

PropRolloverPeriod

public static final java.lang.String PropRolloverPeriod

Constant to indicate the property Roll Over Period.

See Also:

Constant Field Values

PropRolloverFrequency

public static final java.lang.String PropRolloverFrequency

Constant to indicate the property Roll over Frequency.

See Also:

Constant Field Values

Constructor Detail

SmSharedSecretPolicy

public SmSharedSecretPolicy()

Constructs a SiteMinder Shared Secret Policy object. The name and description of this object are not set with this constructor.

SmSharedSecretPolicy

public SmSharedSecretPolicy(java.lang.String oid)

Constructs a Shared Secret Policy object with the specified Object identifier.

Parameters:

oid - Object identifier for the Shared Secret Policy object.

Method Detail

getName

public java.lang.String getName()

Returns null for Shared Secret Policy 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. Shared Secret Policy 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. Shared Secret Policy objects don't have a description property.

Specified by:

setDescription in interface SmObject

Overrides:

setDescription in class SmObjectImpl

Parameters:

description - The description of the object.

getDescription

public java.lang.String getDescription()

Returns null for Shared Secret Policy objects. These objects don't have a name property.

Specified by:

getDescription in interface SmObject

Overrides:

getDescription in class SmObjectImpl

Returns:

null.

getIsEnabled

public boolean getIsEnabled()

Gets the Enabled state of Shared Secret Policy object.

Returns:

The Enabled state of Shared Secret Policy Object

setIsEnabled

public void setIsEnabled(boolean bIsEnabled)

Sets the Enabled state of Shared Secret Policy object.

getRolloverPeriod

public int getRolloverPeriod()

Gets the Roll Over Period for Shared Secret Policy Object

Returns:

The Roll over period for Shared Secret Policy Object

setRolloverPeriod

public void setRolloverPeriod(int nRolloverPeriod)

Sets the Roll Over Period for Shared Secret Policy Object

getRolloverFrequency

public int getRolloverFrequency()

Gets the Roll Over Frequency for Shared Secret Policy Object

Returns:

The Roll over Frequency for Shared Secret Policy Object

setRolloverFrequency

public void setRolloverFrequency(int nRolloverFrequency)

Sets the Roll Over Frequency for Shared Secret Policy Object

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.