com.netegrity.sdk.policyapi
Class SmTrustedHost

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public final class SmTrustedHost
extends SmObjectImpl

Defines a Trusted Host object.

This object has global scope.

Since:

SDK 6.0 SP2

Field Summary

static java.lang.String	Prop4xHost Constant to indicate the properties 4xHost in trustedhost.
static java.lang.String	PropAdmin Constant to indicate the Policy Server administrator.
static java.lang.String	PropEnableRollover Constant to indicate the Trusted Host object's Enable Rollover property.
static java.lang.String	PropFile Constant to indicate the Host Configuration file.
static java.lang.String	PropHostConfig Constant to indicate the Host Configuration Object.
static java.lang.String	PropIpAddress Constant to indicate the Trusted Host object's IP Address property.
static java.lang.String	PropPassword Constant to indicate the Policy Server administrator password.
static java.lang.String	PropTrustedHosts 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

SmTrustedHost()
Constructs a Trusted Host object.

SmTrustedHost(java.lang.String name)
Constructs a Trusted Host object with the specified name.

Method Summary

boolean	get4xHost() Get the 4xHost information whether this object is secondary object for 4x Agent or not.
java.lang.String	getAdmin() Gets the name of the Policy Server Administrator account that will be used to register the trusted host.
int	getEnableRollOver() Returns whether the shared secret used to encrypt communication between the trusted host and the Policy Server should be periodically rolled over.
java.lang.String	getHostConfigFile() Gets the full path to the Host Configuration File that contains registration data for the trusted host after registration is complete.
java.lang.String	getHostConfigObjName() Gets the name of the Host Configuration Object configured on the Policy Server to be used for the trusted host to be registered.
java.lang.String	getIPAddress() Gets the IP address and port of the Policy Server where the trusted host is to be registered.
java.lang.String	getPassword() Gets the password of an administrator account with the rights to register the trusted host with the Policy Server.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	set4xHost(boolean bHost4x) Set the 4xhost value in trustedhost.
void	setAdmin(java.lang.String admin) Sets the name of the administrator account to use to register the trusted host with the Policy Server.
void	setEnableRollOver(int enablerollover) Sets whether the shared secret used to encrypt communication between the trusted host and the Policy Server should be periodically rolled over.
void	setHostConfigFile(java.lang.String hostconfigfile) Sets the full path to the Host Configuration File that will be created to contain registration data for the trusted host when registration is complete.
void	setHostConfigObjName(java.lang.String hostconfigobj) Sets the name of the Host Configuration Object on the Policy Server to be used for the trusted host to be registered.
void	setIPAddress(java.lang.String address) Sets the IP address and port number of the Policy Server where the trusted host is to be registered.
void	setPassword(java.lang.String password) Sets the password of an administrator account with the rights to register the trusted host with the Policy Server.
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

PropTrustedHosts

public static final java.lang.String PropTrustedHosts

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

See Also:

Constant Field Values

PropIpAddress

public static final java.lang.String PropIpAddress

Constant to indicate the Trusted Host object's IP Address property. You can search agents based on this property.

See Also:

Constant Field Values

PropAdmin

public static final java.lang.String PropAdmin

Constant to indicate the Policy Server administrator.

See Also:

Constant Field Values

PropPassword

public static final java.lang.String PropPassword

Constant to indicate the Policy Server administrator password.

See Also:

Constant Field Values

PropHostConfig

public static final java.lang.String PropHostConfig

Constant to indicate the Host Configuration Object.

See Also:

Constant Field Values

PropFile

public static final java.lang.String PropFile

Constant to indicate the Host Configuration file.

See Also:

Constant Field Values

PropEnableRollover

public static final java.lang.String PropEnableRollover

Constant to indicate the Trusted Host object's Enable Rollover property.

See Also:

Constant Field Values

Prop4xHost

public static final java.lang.String Prop4xHost

Constant to indicate the properties 4xHost in trustedhost.

See Also:

Constant Field Values

Constructor Detail

SmTrustedHost

public SmTrustedHost()

Constructs a Trusted Host object. This constructor sets the name and description to an empty string.

SmTrustedHost

public SmTrustedHost(java.lang.String name)

Constructs a Trusted Host object with the specified name.

Parameters:

name - A unique name that represents the trusted host to the Policy Server. This name does not have to be the same as the physical client system that you are registering; it can be any unique name, for example, mytrustedhost.

Note: This name must be unique among trusted hosts and not match the name of any other Web Agent.

Method Detail

getIPAddress

public java.lang.String getIPAddress()

Gets the IP address and port of the Policy Server where the trusted host is to be registered.

Returns:

The IP address and port number of the Policy Server where the trusted host is to be registered.

setIPAddress

public void setIPAddress(java.lang.String address)

Sets the IP address and port number of the Policy Server where the trusted host is to be registered.

Parameters:

address - The IP address of the Policy Server where the trusted host is to be registered. Specify the port of the authentication server only if you are not using the default, which is 44442.

getAdmin

public java.lang.String getAdmin()

Gets the name of the Policy Server Administrator account that will be used to register the trusted host.

Returns:

The name of a SiteMinder administrator a Policy Server Administrator with Register Trusted Hosts privilege.

setAdmin

public void setAdmin(java.lang.String admin)

Sets the name of the administrator account to use to register the trusted host with the Policy Server. .

Parameters:

admin - The name of a SiteMinder administrator a Policy Server Administrator with Register Trusted Hosts privilege.

getPassword

public java.lang.String getPassword()

Gets the password of an administrator account with the rights to register the trusted host with the Policy Server.

Returns:

The password of a Policy Server Administrator account with the rights to register the trusted host.

setPassword

public void setPassword(java.lang.String password)

Sets the password of an administrator account with the rights to register the trusted host with the Policy Server.

Parameters:

password - The password of a Policy Server Administrator account with the rights to register the trusted host.

getHostConfigObjName

public java.lang.String getHostConfigObjName()

Gets the name of the Host Configuration Object configured on the Policy Server to be used for the trusted host to be registered.

Returns:

The name of the Host Configuration Object configured on the Policy Server.

setHostConfigObjName

public void setHostConfigObjName(java.lang.String hostconfigobj)

Sets the name of the Host Configuration Object on the Policy Server to be used for the trusted host to be registered.

This object defines the connection between the trusted host and the Policy Server. For example, to use the default, enter DefaultHostSettings. In most cases, you will have created your own Host Configuration Object.

Note: The entry you specify must match the Host Configuration Object entry set at the Policy Server.

Parameters:

hostconfigobj - The name of the Host Configuration Object configured on the Policy Server.

getHostConfigFile

public java.lang.String getHostConfigFile()

Gets the full path to the Host Configuration File that contains registration data for the trusted host after registration is complete.

Returns:

The full path to the file that contains registration data for the trusted host.

setHostConfigFile

public void setHostConfigFile(java.lang.String hostconfigfile)

Sets the full path to the Host Configuration File that will be created to contain registration data for the trusted host when registration is complete.

Parameters:

hostconfigfile - The full path to the file that contains the registration data. The default file is SmHost.conf.

getEnableRollOver

public int getEnableRollOver()

Returns whether the shared secret used to encrypt communication between the trusted host and the Policy Server should be periodically rolled over.

Returns:

Whether shared secret rollover is enabled.

• 0 Signifies that shared secret rollover is not enabled for the trusted host.
• 1 Signifies that shared secret rollover is enabled for the trusted host.

setEnableRollOver

public void setEnableRollOver(int enablerollover)

Sets whether the shared secret used to encrypt communication between the trusted host and the Policy Server should be periodically rolled over. Key rollover must be enabled at the Policy Server for this feature to work. To disable shared secret rollover or enable it at a later time, you have to re-register the trusted host, or use the Policy Management API to enable or disable shared secret rollover.

Parameters:

enablerollover - Whether shared secret rollover is enabled.

• 0 Enables shared secret rollover for the trusted host.
• 1 Disables shared secret rollover for the trusted host.

get4xHost

public boolean get4xHost()

Get the 4xHost information whether this object is secondary object for 4x Agent or not.

Returns:

4xHost value of boolean type.

• false Signifies that the trusted host was created while registering a 5x agent.
• true Signifies that the trusted host was created for a 4x Agent.

set4xHost

public void set4xHost(boolean bHost4x)

Set the 4xhost value in trustedhost.

Parameters:

bHost4x - Value as true or false.

• false Enables 4xHost rollover for the trusted host.
• true Disables 4xHost rollover for the trusted host.

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.