com.netegrity.sdk.policyapi
Class SmDomain

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

All Implemented Interfaces:

SmObject, java.lang.Cloneable

public class SmDomain
extends SmObjectImpl

Represents a SiteMinder Domain object.

This object has global scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropActiveExprs
static java.lang.String	PropAdmins The object's administrators property.
static java.lang.String	PropDomains Property name to be specified in the method getGlobalObjectNames().
static java.lang.String	PropIMSEnvs
static java.lang.String	PropIsAffiliate
static java.lang.String	PropMode
static java.lang.String	PropPolicies
static java.lang.String	PropRealms The object's Realms property.
static java.lang.String	PropResponseGroups
static java.lang.String	PropResponses
static java.lang.String	PropRuleGroups
static java.lang.String	PropRules The object's Rules property.
static java.lang.String	PropUserDirectories The object's user directories property.
static java.lang.String	PropVariables

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

SmDomain()
Constructs a SiteMinder Domain object.

SmDomain(java.lang.String name)
Constructs a SiteMinder Domain object with the specified name.

Method Summary

boolean	getIsAffiliate() Checks whether the domain is Affiliate.
int	getMode() Checks the mode for the domain
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setIsAffiliate(boolean affiliate) Sets the domain as an Affiliate Domain.
void	setMode(int mode) Sets the mode for the domain.
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

PropDomains

public static final java.lang.String PropDomains

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

See Also:

Constant Field Values

PropAdmins

public static final java.lang.String PropAdmins

The object's administrators property.

See Also:

Constant Field Values

PropUserDirectories

public static final java.lang.String PropUserDirectories

The object's user directories property.

See Also:

Constant Field Values

PropRealms

public static final java.lang.String PropRealms

The object's Realms property.

See Also:

Constant Field Values

PropRules

public static final java.lang.String PropRules

The object's Rules property.

See Also:

Constant Field Values

PropResponses

public static final java.lang.String PropResponses

See Also:

Constant Field Values

PropPolicies

public static final java.lang.String PropPolicies

See Also:

Constant Field Values

PropRuleGroups

public static final java.lang.String PropRuleGroups

See Also:

Constant Field Values

PropResponseGroups

public static final java.lang.String PropResponseGroups

See Also:

Constant Field Values

PropVariables

public static final java.lang.String PropVariables

See Also:

Constant Field Values

PropActiveExprs

public static final java.lang.String PropActiveExprs

See Also:

Constant Field Values

PropIsAffiliate

public static final java.lang.String PropIsAffiliate

See Also:

Constant Field Values

PropMode

public static final java.lang.String PropMode

See Also:

Constant Field Values

PropIMSEnvs

public static final java.lang.String PropIMSEnvs

See Also:

Constant Field Values

Constructor Detail

SmDomain

public SmDomain()

Constructs a SiteMinder Domain object. The name and description of the Domain are not set with this constructor.

SmDomain

public SmDomain(java.lang.String name)

Constructs a SiteMinder Domain object with the specified name.

Parameters:

name - Name of the Domain.

Method Detail

getIsAffiliate

public boolean getIsAffiliate()

Checks whether the domain is Affiliate.

Returns:

true if the Domain is an Affiliate Domain. false otherwise.

setIsAffiliate

public void setIsAffiliate(boolean affiliate)

Sets the domain as an Affiliate Domain.

Parameters:

affiliate - If true the domain is affiliate. false otherwise.

getMode

public int getMode()

Checks the mode for the domain

Returns:

true if the Domain is Affiliated. false otherwise.

setMode

public void setMode(int mode)

Sets the mode for the domain.

Parameters:

mode - - The bits of this integer determines various modes of the domain. Integer is calculated using following bit values

ModeHidden = 0x00000001
This bit is set for hidden domains.

ModeGlobalPoliciesApply = 0x00000002
This bit is set for domains for which Global policies apply.

ModeGlobal = 0x00000004
This bit is set for Global domain.

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.