com.netegrity.sdk.policyapi
Class SmHostConfig

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmHostConfig
extends SmObjectImpl

Represents a SiteMinder Host Configuration Object.

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

This object has global scope.

Since:

SDK 6.0 SP2

Field Summary

static java.lang.String	PropClusters Constant to indicate the Host Configuration object's Clusters property
static java.lang.String	PropEnableFailOver Constant to indicate the Host Configuration object's Enable Failover property.
static java.lang.String	PropFailoverThreshold Constant to indicate the Host Configuration object's Failover Threshold property.
static java.lang.String	PropHostConfigs Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropMaxSocketsPerPort Constant to indicate the Host Configuration object's Maximum Sockets per port property.
static java.lang.String	PropMinSocketsPerPort Constant to indicate the Host Configuration object's Minimum Sockets per port property.
static java.lang.String	PropNewSocketStep Constant to indicate the Host Configuration object's New Socket Step property.
static java.lang.String	PropPolicyServer Constant to indicate the Host Configuration object's Policy Server property.
static java.lang.String	PropRequestTimeout Constant to indicate the Host Configuration object's Request Time Out 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

SmHostConfig()
Constructs a Host Configuration Object in which the object's name and description are set to an empty string.

SmHostConfig(java.lang.String name)
Constructs a Host Configuration Object with the specified name.

Method Summary

java.lang.String	getClusters() Gets TCP/IP connectivity information for clusters of Policy Servers with which the trusted host can communicate.
int	getEnableFailOver() Gets whether the trusted host is configured to communicate with multiple Policy Servers in failover or round-robin operation mode.
int	getFailoverThreshold() Gets failover threshold percentage value for clusters.
int	getMaxSocketPerPort() Gets the configured maximum number of TCP/IP sockets that can be opened between an agent on the trusted host and a particular Policy Server process.
int	getMinSocketPerPort() Gets the number of TCP/IP connections that should be opened between an agent on the trusted host and each Policy Server process at start up.
int	getNewSocketStep() Gets the incremental number of TCP/IP connections that should be opened between an agent and a particular Policy Server process when demand increases and new connections are required.
int	getRequestTimeout() Gets the number of seconds that an agent on the trusted host will wait before deciding that a Policy Server is unavailable.
java.lang.String	getServers() Gets TCP/IP connectivity information for the Policy Server(s) with which the trusted host can communicate.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setClusters(java.lang.String clusters) Specifies TCP/IP connectivity information for clusters of Policy Servers with which the trusted host can communicate.
void	setEnableFailOver(int enableFailover) Sets whether the trusted host is configured to communicate with multiple Policy Server in failover or round-robin operation mode.
void	setFailoverThreshold(int failoverThreshold) Sets the failover threshold percentage value for clusters.
void	setMaxSocketPerPort(int maxSocketPerPort) Sets the maximum number of TCP/IP connections that can be opened between an agent on the trusted host and a particular Policy Server process.
void	setMinSocketPerPort(int minSocketPerPort) Sets the number of TCP/IP connections that should be opened between an agent on the trusted host and each Policy Server process at start up.
void	setNewSocketStep(int newsocketstep) Sets the incremental number of TCP/IP connections that should be opened between an agent and a particular Policy Server process when demand increases and new connections are required.
void	setRequestTimeout(int requestTimeout) Sets the length of time (in seconds) that an agent on the trusted host will wait for a response from a Policy Server before deciding that the Policy Server is unavailable.
void	setServers(java.lang.String list) Specifies TCP/IP connectivity information for the Policy Server(s) with which the trusted host can communicate.
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

PropHostConfigs

public static final java.lang.String PropHostConfigs

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

See Also:

Constant Field Values

PropMaxSocketsPerPort

public static final java.lang.String PropMaxSocketsPerPort

Constant to indicate the Host Configuration object's Maximum Sockets per port property.

See Also:

Constant Field Values

PropMinSocketsPerPort

public static final java.lang.String PropMinSocketsPerPort

Constant to indicate the Host Configuration object's Minimum Sockets per port property.

See Also:

Constant Field Values

PropNewSocketStep

public static final java.lang.String PropNewSocketStep

Constant to indicate the Host Configuration object's New Socket Step property.

See Also:

Constant Field Values

PropRequestTimeout

public static final java.lang.String PropRequestTimeout

Constant to indicate the Host Configuration object's Request Time Out property.

See Also:

Constant Field Values

PropEnableFailOver

public static final java.lang.String PropEnableFailOver

Constant to indicate the Host Configuration object's Enable Failover property.

See Also:

Constant Field Values

PropFailoverThreshold

public static final java.lang.String PropFailoverThreshold

Constant to indicate the Host Configuration object's Failover Threshold property.

See Also:

Constant Field Values

PropPolicyServer

public static final java.lang.String PropPolicyServer

Constant to indicate the Host Configuration object's Policy Server property.

See Also:

Constant Field Values

PropClusters

public static final java.lang.String PropClusters

Constant to indicate the Host Configuration object's Clusters property

See Also:

Constant Field Values

Constructor Detail

SmHostConfig

public SmHostConfig()

Constructs a Host Configuration Object in which the object's name and description are set to an empty string.

SmHostConfig

public SmHostConfig(java.lang.String name)

Constructs a Host Configuration Object with the specified name.

Parameters:

name - Name of the Host Configuration object.

Method Detail

getServers

public java.lang.String getServers()

Gets TCP/IP connectivity information for the Policy Server(s) with which the trusted host can communicate.

Returns:

String containing IP addresses and port numbers for the Policy Server(s) with which the trusted host can communicate.

Policy Server addresses are separated from associated port numbers by commas (,). Multiple Policy Server entries are separated by semicolons (;).

setServers

public void setServers(java.lang.String list)

Specifies TCP/IP connectivity information for the Policy Server(s) with which the trusted host can communicate.

Note: Policy Server data specified using this method is ignored if cluster data is specified using the setClusters() method.

Policy Servers are defined by the list parameter as a string in the following format:

 <Policy_Server>,<IP_Port>;<Policy_Server>,<IP_Port>;...

Where:

<Policy_Server_Address> Is the IP address or resolvable domain name of a Policy Server.
<IP_Port> Is the IP port of the Policy Server service.

That is, Policy Server addresses are separated from associated port numbers by commas (,) and multiple Policy Server entries are separated by semicolons (;).

Examples:

 172.26.14.9,44443

 172.26.14.9,44441;172.26.4.8,44443;172.26.14.4,44441;172.26.14.5,44443

 ps1.example.com,44441;ps2.example.com,44442

Parameters:

list - String containing IP addresses and port numbers for the Policy Server(s) with which the trusted host can communicate.

getClusters

public java.lang.String getClusters()

Gets TCP/IP connectivity information for clusters of Policy Servers with which the trusted host can communicate.

Returns:

String specifying IP addresses and port numbers for the clusters of Policy Server(s) with which the trusted host can communicate.

Cluster specifications are separated by colons. Within each cluster specification, Policy Server addresses are separated from associated port numbers by commas (,) and Policy Server entries are separated by semicolons (;).

setClusters

public void setClusters(java.lang.String clusters)

Specifies TCP/IP connectivity information for clusters of Policy Servers with which the trusted host can communicate.

Clustering servers enables failover from one group of servers to another group and also improves server performance by providing dynamic load balancing between the servers in a cluster.

Policy Server clusters are defined by the list parameter as a colon-separated string with the following format:

 <Policy_Server_Cluster>:<Policy_Server_Cluster>:<Policy_Server_Cluster>...

Where:

<Policy_Server_Cluster> Is the TCP/IP connectivity information (IP address/domain name and port number) for each Policy Server in the cluster. Within each cluster, Policy Server addresses are separated from associated port numbers by commas (,) and multiple Policy Server entries are separated by semicolons (;).

Examples:

 172.26.14.9,44441;172.26.14.8,44443;172.26.14.4,44441:172.26.14.5,44443;
172.25.14.6,44443;172.25.14.7,44443

 ps1.example.com,44441;ps2.example.com,44442:ps3.example.com.44441;
ps4.example.com,44441:ps5.example.com.44441;ps6.example.com,44441

Parameters:

list - String specifying IP addresses and port numbers for the clusters of Policy Server(s) with which the trusted host can communicate.

getEnableFailOver

public int getEnableFailOver()

Gets whether the trusted host is configured to communicate with multiple Policy Servers in failover or round-robin operation mode.

Returns:

Whether failover operation mode is enabled or not:

• 0 Signifies that the trusted host is not configured for failover mode but to operate in round-robin mode.
• 1 Signifies that the trusted host is configured for failover mode of operation.

setEnableFailOver

public void setEnableFailOver(int enableFailover)

Sets whether the trusted host is configured to communicate with multiple Policy Server in failover or round-robin operation mode.

Parameters:

enableFailover - Sets whether failover is enabled:

• 0 Configures the trusted host to operate in round-robin mode.
• 1 Configures the trusted host to operate in failover mode.

getFailoverThreshold

public int getFailoverThreshold()

Gets failover threshold percentage value for clusters.

Returns:

The failover threshold percentage value.

setFailoverThreshold

public void setFailoverThreshold(int failoverThreshold)

Sets the failover threshold percentage value for clusters.

The failover threshold is the percentage of Policy Servers within a cluster that must be active. If the percentage of active servers falls below the specifed percentage, the cluster fails over to the next available cluster in the list of clusters.

Parameters:

failoverThreshold - The failover threshold (a percentage value) for clusters.

getMaxSocketPerPort

public int getMaxSocketPerPort()

Gets the configured maximum number of TCP/IP sockets that can be opened between an agent on the trusted host and a particular Policy Server process.

Returns:

The maximum number of TCP/IP sockets that can be opened between an agent on the trusted host and a particular Policy Server process.

setMaxSocketPerPort

public void setMaxSocketPerPort(int maxSocketPerPort)

Sets the maximum number of TCP/IP connections that can be opened between an agent on the trusted host and a particular Policy Server process.

By default, this value is set to 20, which is generally sufficient for low- and medium-traffic Web sites. If you are managing a high-traffic Web site or if you have defined agent identities for virtual servers, you may want to increase this number.

Parameters:

maxSocketPerPort - The maximum number of TCP/IP connections that can be opened between an agent on the trusted host and a particular Policy Server process.

getMinSocketPerPort

public int getMinSocketPerPort()

Gets the number of TCP/IP connections that should be opened between an agent on the trusted host and each Policy Server process at start up.

Returns:

The number of TCP/IP connections that will be opened between an agent on the trusted host and each Policy Server process at start up.

setMinSocketPerPort

public void setMinSocketPerPort(int minSocketPerPort)

Sets the number of TCP/IP connections that should be opened between an agent on the trusted host and each Policy Server process at start up.

The default value is 2. If you are managing a high-traffic Web site, you may want to increase this number.

Parameters:

minSocketPerPort - The number of TCP/IP connections that should be opened between an agent on the trusted host and each Policy Server process at start up.

getNewSocketStep

public int getNewSocketStep()

Gets the incremental number of TCP/IP connections that should be opened between an agent and a particular Policy Server process when demand increases and new connections are required.

Returns:

The number of connections the Agent opens when new connections are required.

setNewSocketStep

public void setNewSocketStep(int newsocketstep)

Sets the incremental number of TCP/IP connections that should be opened between an agent and a particular Policy Server process when demand increases and new connections are required.

The default value is 2. You should increase this value if you want more connections to be added.

Parameters:

newsocketstep - The number of additional connections an agent should open to a particular Policy Server process when demand increases.

getRequestTimeout

public int getRequestTimeout()

Gets the number of seconds that an agent on the trusted host will wait before deciding that a Policy Server is unavailable.

Returns:

The number of seconds an agent on the trusted host will wait before deciding that a policy server is unavailable.

setRequestTimeout

public void setRequestTimeout(int requestTimeout)

Sets the length of time (in seconds) that an agent on the trusted host will wait for a response from a Policy Server before deciding that the Policy Server is unavailable. The default value is 60 seconds.

If the Policy Server is busy due to heavy traffic or a slow network connection, you may want to increase this value.

Parameters:

requestTimeout - The number of seconds an agent on the trusted host will wait before deciding that a Policy Server is unavailable.

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.