netegrity.siteminder.javaagent
Class InitDef

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

public class InitDef

extends java.lang.Object

Holds the data needed to define an agent or client application for use with SiteMinder services. To satisfy the protocol between agent and server, the agent must have a unique name and shared secret. These are defined on the server side through the SiteMinder user interface or the Policy Management API.

Since:

SiteMinder 4.0

See Also:

AgentAPI, ServerDef

Field Summary

static int	CRYPTO_OP_COMPAT
static int	CRYPTO_OP_F1402
static int	CRYPTO_OP_F1402MD5
static int	CRYPTO_OP_MIGRATE_F1402
static int	CRYPTO_OP_UNSET Crypto Operational Mode values.
static int	FIPS140_COMPAT Supported values for the agent connection FIPS mode as used by the deprecated methods getFIPSMode() and setFIPSMode().
static int	FIPS140_ONLY

Constructor Summary

InitDef()
Initializes the object with no server definition (add server definitions by calling addServerDef().

InitDef(java.lang.String hostName, java.lang.String sharedSecret, boolean failOver, ServerDef sd)
Initializes the object with a definition of a single non-clustered server (other server definitions can be added by calling addServerDef().

InitDef(java.lang.String hostName, java.lang.String sharedSecret, int failOverThreshold, ServerDef sd)
Initializes the object with a definition of a single clustered server (other server definitions can be added by calling addServerDef().

Method Summary

void	addServerDef(ServerDef sd) Adds another server definition from the information in an existing ServerDef object.
void	addServerDef(java.lang.String serverIpAddress, int connectionMin, int connectionMax, int connectionStep, int timeout, int authorizationPort, int authenticationPort, int accountingPort) Adds another non-clustered server definition using the specified server information.
void	addServerDef(java.lang.String serverIpAddress, int connectionMin, int connectionMax, int connectionStep, int timeout, int authorizationPort, int authenticationPort, int accountingPort, int clusterSeq) Adds another clustered server definition using the specified server information.
int	failOverThreshold() Retrieves the failover threshold percentage for a cluster of servers.
int	getCryptoOpMode() Returns the Crypto Operational Mode -- the "full" FIPS mode instead of the connection FIPS mode.
int	getFIPSMode() Deprecated. This method will be removed in future versions of the API, please use getCryptoOpMode()
java.lang.String	getHostName() Returns the host name.
ServerDef	getServerAt(int index) Gets a particular server definition.
int	getServerCount() Gets the number of servers associated with the agent.
java.util.Vector	getServers() Returns a vector of servers.
java.lang.String	getSharedSecret() Returns the shared secret.
boolean	isFailOver() Specifies whether failover is enabled for non-clustered servers.
void	setCryptoOpMode(int cryptoOpMode) Sets the Crypto Operational Mode.
void	setFIPSMode(int fipsMode) Deprecated. This method will be removed in future versions of the API, please use setCryptoOpMode(int). Replace setFIPSMode(FIPS140_COMPAT) with setCryptoOpMode(CRYPTO_OP_COMPAT). Replace setFIPSMode(FIPS140_ONLY) with either setCryptoOpMode(CRYPTO_OP_MIGRATE_F1402) or setCryptoOpMode(CRYPTO_OP_F1402).

Methods inherited from class java.lang.Object

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

Field Detail

FIPS140_COMPAT

public static final int FIPS140_COMPAT

Supported values for the agent connection FIPS mode as used by the deprecated methods getFIPSMode() and setFIPSMode().

See Also:

Constant Field Values

FIPS140_ONLY

public static final int FIPS140_ONLY

See Also:

Constant Field Values

CRYPTO_OP_UNSET

public static final int CRYPTO_OP_UNSET

Crypto Operational Mode values. Passed via setCryptoOpMode() to the AgentAPI during init to inform it of the desired mode so it can determine the agent connection FIPS mode. Retrieved by getCryptoOpMode() when retrieving the mode via reverse JNI.

See Also:

Constant Field Values

CRYPTO_OP_COMPAT

public static final int CRYPTO_OP_COMPAT

See Also:

Constant Field Values

CRYPTO_OP_MIGRATE_F1402

public static final int CRYPTO_OP_MIGRATE_F1402

See Also:

Constant Field Values

CRYPTO_OP_F1402

public static final int CRYPTO_OP_F1402

See Also:

Constant Field Values

CRYPTO_OP_F1402MD5

public static final int CRYPTO_OP_F1402MD5

See Also:

Constant Field Values

Constructor Detail

InitDef

public InitDef()

Initializes the object with no server definition (add server definitions by calling addServerDef().

InitDef

public InitDef(java.lang.String hostName,
               java.lang.String sharedSecret,
               boolean failOver,
               ServerDef sd)

Initializes the object with a definition of a single non-clustered server (other server definitions can be added by calling addServerDef().

Use this constructor for agents associated with non-clustered servers. If the agent is associated with clustered servers, use the constructor InitDef(String,String,int,ServerDef).

Parameters:

hostName - The agent name. This name must match the agent name provided to the Policy Server. The agent name is not case sensitive.

sharedSecret - The shared secret as defined in the SiteMinder user interface (case sensitive).

failOver - Indicates whether failover or round-robin behavior is enabled. If true, failover is enabled. SiteMinder sends requests to another server if it can't contact the current server. If false, round-robin is enabled. SiteMinder dynamically distributes requests among the servers based on the performance capabilities of each server.

InitDef

public InitDef(java.lang.String hostName,
               java.lang.String sharedSecret,
               int failOverThreshold,
               ServerDef sd)

Initializes the object with a definition of a single clustered server (other server definitions can be added by calling addServerDef().

Use this constructor for agents associated with clustered servers. If the agent is associated with non-clustered servers, use the constructor InitDef(String,String,boolean,ServerDef).

Parameters:

hostName - The agent name. This name must match the agent name provided to the Policy Server. The agent name is not case sensitive.

sharedSecret - The shared secret as defined in the SiteMinder user interface (case sensitive).

failOverThreshold - The percentage of servers within a cluster that must be available for Policy Server requests. When the number of available servers in a cluster falls below the failover percentage, failover to the next cluster occurs. For example, if the failover percentage is 60 and a cluster has five servers, failover occurs when the number of available servers in the cluster falls below three.

Since:

SDK 6.0

Method Detail

addServerDef

public void addServerDef(ServerDef sd)

Adds another server definition from the information in an existing ServerDef object.

Parameters:

sd - The server definition to add.

addServerDef

public void addServerDef(java.lang.String serverIpAddress,
                         int connectionMin,
                         int connectionMax,
                         int connectionStep,
                         int timeout,
                         int authorizationPort,
                         int authenticationPort,
                         int accountingPort,
                         int clusterSeq)

Adds another clustered server definition using the specified server information.

If the agent is associated with non-clustered servers, call addServerDef(String,int,int,int,int,int,int,int).

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 parameters authorizationPort, authenticationPort, and accountingPort all reference the same port number. The three parameters are maintained for backward compatibility.

Parameters:

serverIpAddress - Server IP address.

connectionMin - Minimum number of connections.

connectionMax - Maximum number of connections.

connectionStep - Number of connections to allocate when out of connections.

timeout - Connection timeout in seconds.

authorizationPort - Authorization server port (0 for none).

authenticationPort - Authentication server port (0 for none).

accountingPort - Accounting server port (0 for none).

clusterSeq - The cluster sequence number. This parameter serves two purposes:

• Assigns a failover sequence number to the 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

addServerDef

public void addServerDef(java.lang.String serverIpAddress,
                         int connectionMin,
                         int connectionMax,
                         int connectionStep,
                         int timeout,
                         int authorizationPort,
                         int authenticationPort,
                         int accountingPort)

Adds another non-clustered server definition using the specified server information.

If the agent is associated with clustered servers, call addServerDef(String,int,int,int,int,int,int,int,int).

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 parameters authorizationPort, authenticationPort, and accountingPort all reference the same port number. The three parameters are maintained for backward compatibility.

Parameters:

serverIpAddress - Server IP address.

connectionMin - Minimum number of connections.

connectionMax - Maximum number of connections.

connectionStep - Number of connections to allocate when out of connections.

timeout - Connection timeout in seconds.

authorizationPort - Authorization server port (0 for none).

authenticationPort - Authentication server port (0 for none).

accountingPort - Accounting server port (0 for none).

getServerCount

public int getServerCount()

Gets the number of servers associated with the agent.

Returns:

The count of server definitions.

getServerAt

public ServerDef getServerAt(int index)

Gets a particular server definition.

Parameters:

index - The index into the servers (zero-based).

Returns:

The corresponding server definition.

getServers

public java.util.Vector getServers()

Returns a vector of servers.

Returns:

Vector of servers.

getHostName

public java.lang.String getHostName()

Returns the host name.

Returns:

Host name.

getSharedSecret

public java.lang.String getSharedSecret()

Returns the shared secret.

Returns:

The shared secret.

isFailOver

public boolean isFailOver()

Specifies whether failover is enabled for non-clustered servers.

For more information about failover for non-clustered servers, see InitDef(String,String,boolean,ServerDef).

Returns:

true if failover is enabled. false otherwise.

failOverThreshold

public int failOverThreshold()

Retrieves the failover threshold percentage for a cluster of servers.

For more information about the failover threshold percentage, see InitDef(String,String,int,ServerDef).

Returns:

The failover threshold percentage.

Since:

SDK 6.0

setCryptoOpMode

public void setCryptoOpMode(int cryptoOpMode)

Sets the Crypto Operational Mode. The AgentAPI init uses this value to determine the "FIPS mode" for the agent connection.

Parameters:

cryptoOpMode - is the mode to set.

getCryptoOpMode

public int getCryptoOpMode()

Returns the Crypto Operational Mode -- the "full" FIPS mode instead of the connection FIPS mode. Used when retrieving the mode via reverse JNI.

setFIPSMode

public void setFIPSMode(int fipsMode)

Deprecated. This method will be removed in future versions of the API, please use setCryptoOpMode(int). Replace setFIPSMode(FIPS140_COMPAT) with setCryptoOpMode(CRYPTO_OP_COMPAT). Replace setFIPSMode(FIPS140_ONLY) with either setCryptoOpMode(CRYPTO_OP_MIGRATE_F1402) or setCryptoOpMode(CRYPTO_OP_F1402).

Sets the desired FIPS mode of the agent connection to the Policy Server.

Parameters:

fipsMode - FIPS140_COMPAT to make a "pre-FIPS" 6.x style connection or FIPS140_ONLY to make new style connection using AES encryption.

Throws:

java.lang.IllegalArgumentException - If fipsMode is not one of the expected values.

getFIPSMode

public int getFIPSMode()

Deprecated. This method will be removed in future versions of the API, please use getCryptoOpMode()

Returns the FIPS mode set for the agent connection.