CA SiteMinder
Java SDK r12.52


com.netegrity.sdk.policyapi
Class SmAgent

java.lang.Object
  extended by com.netegrity.sdk.policyapi.SmObjectImpl
      extended by com.netegrity.sdk.policyapi.SmAgent
All Implemented Interfaces:
SmObject, java.lang.Cloneable

public final class SmAgent
extends SmObjectImpl

Represents a SiteMinder Agent object.

This object has global scope.

Since:
SDK 2.0

Field Summary
static java.lang.String PropAgents
          Property name to be specified in the method getGlobalObjectNames().
static java.lang.String PropAgentType
          The object's Agent Type property (searchable).
static java.lang.String PropIpAddr
          The object's IP Address property (searchable).
static java.lang.String PropRealmHintAttrId
          The object's Realm Hint Attribute property.
static java.lang.String PropSecret
          The object's Shared Secret property.
 
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
SmAgent()
          Constructs an Agent object.
SmAgent(java.lang.String name)
          Constructs an Agent object with the specified name.
 
Method Summary
 SmObjId getAgentType()
          Gets the object identifier of the type of Agent.
 java.lang.String getIpAddr()
          Gets the IP address of the machine where the Agent resides.
 int getRealmHintAttrId()
          Gets the Realm hint attribute of the Agent.
 java.lang.String getSecret()
          Gets the shared secret of the Agent.
 void readProperties(java.util.Hashtable properties)
          Copies the object properties from the specified hashtable.
 void setAgentType(java.lang.Object agentType)
          Sets the type of Agent.
 void setIpAddr(java.lang.String address)
          Sets the IP address of the machine where the Agent resides.
 void setRealmHintAttrId(int realmHintAttrId)
          Sets the Realm hint attribute of the Agent.
 void setSecret(java.lang.String secret)
          Sets the shared secret of the Agent.
 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

PropAgents

public static final java.lang.String PropAgents
Property name to be specified in the method getGlobalObjectNames().

See Also:
Constant Field Values

PropAgentType

public static final java.lang.String PropAgentType
The object's Agent Type property (searchable). You can search agents based on this property.

See Also:
Constant Field Values

PropIpAddr

public static final java.lang.String PropIpAddr
The object's IP Address property (searchable). You can search agents based on this property.

See Also:
Constant Field Values

PropSecret

public static final java.lang.String PropSecret
The object's Shared Secret property.

See Also:
Constant Field Values

PropRealmHintAttrId

public static final java.lang.String PropRealmHintAttrId
The object's Realm Hint Attribute property.

See Also:
Constant Field Values
Constructor Detail

SmAgent

public SmAgent()
Constructs an Agent object. This constructor sets the name and description to an empty string. By default, the Agent type is set to SmAgentType.DefaultAgentType.


SmAgent

public SmAgent(java.lang.String name)
Constructs an Agent object with the specified name. By default, the Agent type is set to SmAgentType.DefaultAgentType.

Parameters:
name - Name of the agent. Agent names are converted to lower case when written to the policy store.
Method Detail

getIpAddr

public java.lang.String getIpAddr()
Gets the IP address of the machine where the Agent resides.

Returns:
The IP address of the machine where the Agent resides.

setIpAddr

public void setIpAddr(java.lang.String address)
Sets the IP address of the machine where the Agent resides.

Parameters:
address - The IP address of the machine where the Agent resides.

getSecret

public java.lang.String getSecret()
Gets the shared secret of the Agent.

Returns:
The shared secret of the Agent.

setSecret

public void setSecret(java.lang.String secret)
Sets the shared secret of the Agent.

Parameters:
secret - The shared secret of the Agent.

getAgentType

public SmObjId getAgentType()
Gets the object identifier of the type of Agent.

Returns:
The object identifier of the type of Agent.

setAgentType

public void setAgentType(java.lang.Object agentType)
Sets the type of Agent.

Parameters:
agentType - The object identifier of the type of Agent.

getRealmHintAttrId

public int getRealmHintAttrId()
Gets the Realm hint attribute of the Agent. The hint attribute is a RADIUS attribute that is sent by the RADIUS client device.

Returns:
The Realm hint attribute of the Agent.

setRealmHintAttrId

public void setRealmHintAttrId(int realmHintAttrId)
Sets the Realm hint attribute of the Agent. The hint attribute is a RADIUS attribute that is sent by the RADIUS client device.

Parameters:
realmHintAttrId - The Realm hint attribute of the Agent.

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.

CA SiteMinder
Java SDK r12.52

Wed 11/06/2013

http://ca.com
Copyright (c) 2013 CA.