netegrity.siteminder.javaagent
Class ServerDef

java.lang.Object
  |
  +--netegrity.siteminder.javaagent.ServerDef

public class ServerDef

extends java.lang.Object

Holds information needed to define a connection between the client application and the Policy Server.

You can use this object to define either a clustered server or a non-clustered server. For information about clustered servers and non-clustered servers, see the CA eTrust SiteMinder Developer's Guide for Java.

Note: The single-process Policy Server introduced in SiteMinder v6.0 combines the previously separate Authentication, Authorization, and Accounting processes into one combined process whose requests go through one TCP port. As a result, the authorizationPort, authenticationPort, and accountingPort fields all reference the same port number. The three fields are maintained for backward compatibility.

Since:

SiteMinder 4.0

See Also:

AgentAPI

Field Summary

int	accountingPort Accounting server port (0 for none).
int	authenticationPort Authentication server port (0 for none).
int	authorizationPort Authorization server port (0 for none).
int	clusterSeq Cluster sequence number.
int	connectionMax Maximum number of connections.
int	connectionMin Number of initial connections.
int	connectionStep Number of connections to allocate when out of connections.
java.lang.String	serverIpAddress Server IP address.
int	timeout Connection timeout in seconds.

Constructor Summary

ServerDef()
Creates an empty ServerDef object.

Methods inherited from class java.lang.Object

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

Field Detail

serverIpAddress

public java.lang.String serverIpAddress

Server IP address.

connectionMin

public int connectionMin

Number of initial connections.

connectionMax

public int connectionMax

Maximum number of connections.

connectionStep

public int connectionStep

Number of connections to allocate when out of connections.

timeout

public int timeout

Connection timeout in seconds.

authorizationPort

public int authorizationPort

Authorization server port (0 for none).

authenticationPort

public int authenticationPort

Authentication server port (0 for none).

accountingPort

public int accountingPort

Accounting server port (0 for none).

clusterSeq

public int clusterSeq

Cluster sequence number.

If the agent is not associated with clusters, set this field to 0 (the default).

This value serves two purposes:

• Assigns a failover sequence number to a cluster. When the number of active servers in a cluster falls below the failover percentage, SiteMinder sends requests to the next cluster in the cluster sequence.
• Populates a cluster with servers. All servers with the same cluster sequence number are considered to be in the same cluster.

The first cluster in the cluster sequence is 1. SiteMinder sends requests to this cluster (called the primary cluster) as long as the number of available servers remains at or above the failover percentage.

Since:

SDK 6.0

Constructor Detail

ServerDef

public ServerDef()

Creates an empty ServerDef object.