com.netegrity.sdk.policyapi
Class SmAgentConfig

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmAgentConfig
extends SmObjectImpl

Represents a SiteMinder Agent Configuration object.

For information about Agent Configuration objects, see Policy Configuration Guide and the Web Agent Configuration Guide.

This object has global scope.

Since:

SDK 6.0 SP2

Field Summary

static java.lang.String	PropAgentConfigProperties
static java.lang.String	PropAgentConfigs 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

SmAgentConfig()
Constructs an Agent Configuration object with the name and description set to an empty strings.

SmAgentConfig(java.lang.String name)
Constructs an Agent Configuration object with the specified name.

Method Summary

void	getAgentConfigProperties(SmProperty[] properties) Gets Agent Configuration object parameters, filling the passed array of SmProperty objects with the contents of the private hashtable containing the properties of an Agent Configuration object.
int	getPropNum() Gets the number of properties specified in the Agent Configuration object (excluding the object's directory object identifier (OID), Name, ClassName and Description).
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	removeAgentConfigProperties() Removes all properties of the Agent Configuration Object.
SmProperty	removeAgentConfigProperty(SmProperty property) Removes the specified parameter of the Agent Configuration Object.
void	setAgentConfigProperties(SmProperty[] properties) Creates a private hashtable containing Agent Configuration object parameters from passed SmProperty objects.
void	setAgentConfigProperty(SmProperty property) Adds a new agent configuration parameter or updates value of an existing one.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

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

getDescription, getName, getObjectClassname, getOid, isDomainObject, isWriteable, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

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

Field Detail

PropAgentConfigs

public static final java.lang.String PropAgentConfigs

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

See Also:

Constant Field Values

PropAgentConfigProperties

public static final java.lang.String PropAgentConfigProperties

See Also:

Constant Field Values

Constructor Detail

SmAgentConfig

public SmAgentConfig()

Constructs an Agent Configuration object with the name and description set to an empty strings.

SmAgentConfig

public SmAgentConfig(java.lang.String name)

Constructs an Agent Configuration object with the specified name.

Parameters:

name - Name of the Agent Configuration Object.

Method Detail

getPropNum

public int getPropNum()

Gets the number of properties specified in the Agent Configuration object (excluding the object's directory object identifier (OID), Name, ClassName and Description).

Returns:

The number of properties specified in the Agent Configuration Object.

getAgentConfigProperties

public void getAgentConfigProperties(SmProperty[] properties)

Gets Agent Configuration object parameters, filling the passed array of SmProperty objects with the contents of the private hashtable containing the properties of an Agent Configuration object.

Parameters:

properties - Array of SmProperty objects containing Agent Configuration object parameters.

setAgentConfigProperties

public void setAgentConfigProperties(SmProperty[] properties)

Creates a private hashtable containing Agent Configuration object parameters from passed SmProperty objects. parameters.

Parameters:

properties - Array of SmProperty objects containing Agent Configuration object parameters

setAgentConfigProperty

public void setAgentConfigProperty(SmProperty property)

Adds a new agent configuration parameter or updates value of an existing one. Performs case-insensitive search of the parameter name. If one is found, the parameter value is updated.

Parameters:

property - An agent configuration parameter

removeAgentConfigProperties

public void removeAgentConfigProperties()

Removes all properties of the Agent Configuration Object.

removeAgentConfigProperty

public SmProperty removeAgentConfigProperty(SmProperty property)

Removes the specified parameter of the Agent Configuration Object. The parameter name is matched ignoring the case.

Parameters:

property - Name-value of the property to be removed

Returns:

Name-value of the property that was removed. Returns null if the property was not found.

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.