com.netegrity.sdk.policyapi
Class SmKeyManagement

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmKeyManagement
extends SmObjectImpl

Represents a SiteMinder Key Management object.

Key Management objects do not have a name or a description.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropChangeFreq Constant to indicate the property Change Frequency.
static java.lang.String	PropChangeValue Constant to indicate the property Change Value.
static java.lang.String	PropFireHour Constant to indicate the property Fire Hour
static java.lang.String	PropIsEnabled Constant to indicate the property Enabled.
static java.lang.String	PropKeyManagement Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropNewKeySetTime Constant to indicate the property New Key Time
static java.lang.String	PropOldKeySetTime Constant to indicate the property Old Key Time
static java.lang.String	PropPersistentKey Constant to indicate the property Persistent Key.

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

SmKeyManagement()
Constructs a SiteMinder Key Management object.

SmKeyManagement(java.lang.String oid)
Constructs a Key Management object with the specified Object identifier.

Method Summary

int	getChangeFrequency() Gets the Change Frequency for Key Management Object
int	getChangeValue() Gets the Change Value for Key Management Object
java.lang.String	getDescription() Returns null for Key Management objects.
int	getFireHour() Gets the Fire Hour for Key Management Object
boolean	getIsEnabled() Gets the Enabled state of Key Management object.
java.lang.String	getName() Returns null for Key Management objects.
int	getNewKeySetTime() Gets the New Key Set Time for Key Management Object
int	getOldKeySetTime() Gets the Old Key Set Time for Key Management Object
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setChangeFrequency(int nChangeFreq) Sets the Change Frequency for Key Management Object
void	setChangeValue(int nChangeValue) Sets the Change Value for Key Management Object
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setFireHour(int nFireHour) Sets the Fire Hour for Key Management Object
void	setIsEnabled(boolean bIsEnabled) Sets the Enabled state of Key Management object.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setNewKeySetTime(int nNewKeySetTime) Sets the New Key Set Time for Key Management Object
void	setOldKeySetTime(int nOldKeySetTime) Sets the Old Key Set Time for Key Management 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

PropKeyManagement

public static final java.lang.String PropKeyManagement

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

PropChangeFreq

public static final java.lang.String PropChangeFreq

Constant to indicate the property Change Frequency.

See Also:

Constant Field Values

PropChangeValue

public static final java.lang.String PropChangeValue

Constant to indicate the property Change Value.

See Also:

Constant Field Values

PropNewKeySetTime

public static final java.lang.String PropNewKeySetTime

Constant to indicate the property New Key Time

See Also:

Constant Field Values

PropOldKeySetTime

public static final java.lang.String PropOldKeySetTime

Constant to indicate the property Old Key Time

See Also:

Constant Field Values

PropFireHour

public static final java.lang.String PropFireHour

Constant to indicate the property Fire Hour

See Also:

Constant Field Values

PropPersistentKey

public static final java.lang.String PropPersistentKey

Constant to indicate the property Persistent Key.

See Also:

Constant Field Values

Constructor Detail

SmKeyManagement

public SmKeyManagement()

Constructs a SiteMinder Key Management object. The name and description of this object are not set with this constructor.

SmKeyManagement

public SmKeyManagement(java.lang.String oid)

Constructs a Key Management object with the specified Object identifier.

Parameters:

oid - Object identifier for the Key Management object.

Method Detail

getName

public java.lang.String getName()

Returns null for Key Management 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. Key Management 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. Key Management 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 Key Management 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 Key Management object.

Returns:

The Enabled state of Key Management Object

setIsEnabled

public void setIsEnabled(boolean bIsEnabled)

Sets the Enabled state of Key Management object.

Parameters:

The - Enabled state of Key Management Object

getChangeFrequency

public int getChangeFrequency()

Gets the Change Frequency for Key Management Object

Returns:

The ChangeFrequency for Key Management Object

setChangeFrequency

public void setChangeFrequency(int nChangeFreq)

Sets the Change Frequency for Key Management Object

Parameters:

The - Change Frequency for Key Management Object

getChangeValue

public int getChangeValue()

Gets the Change Value for Key Management Object

Returns:

The ChangeValue for Key Management Object

setChangeValue

public void setChangeValue(int nChangeValue)

Sets the Change Value for Key Management Object

Parameters:

The - Change Value for Key Management Object

getNewKeySetTime

public int getNewKeySetTime()

Gets the New Key Set Time for Key Management Object

Returns:

The New Key Set Time for Key Management Object

setNewKeySetTime

public void setNewKeySetTime(int nNewKeySetTime)

Sets the New Key Set Time for Key Management Object

Parameters:

The - New Key Set Time for Key Management Object

getOldKeySetTime

public int getOldKeySetTime()

Gets the Old Key Set Time for Key Management Object

Returns:

The Old Key Set Time for Key Management Object

setOldKeySetTime

public void setOldKeySetTime(int nOldKeySetTime)

Sets the Old Key Set Time for Key Management Object

Parameters:

The - Old Key Set Time for Key Management Object

getFireHour

public int getFireHour()

Gets the Fire Hour for Key Management Object

Returns:

The Fire Hour for Key Management Object

setFireHour

public void setFireHour(int nFireHour)

Sets the Fire Hour for Key Management Object

Parameters:

The - Fire Hour for Key Management 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.