com.netegrity.sdk.policyapi
Class SmRealm

java.lang.Object
  com.netegrity.sdk.policyapi.SmObjectImpl
      com.netegrity.sdk.policyapi.SmDomainObjectImpl
          com.netegrity.sdk.policyapi.SmRealm

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public class SmRealm
extends SmDomainObjectImpl

Represents a SiteMinder Realm object.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static java.lang.String	PropAgent Constant to indicate the property Agent (searchable).
static java.lang.String	PropAgentType Constant to indicate the property Agent Type (searchable).
static java.lang.String	PropAzUserDirOid Constant to indicate the property Authorization Directory Object Identifier (searchable).
static java.lang.String	PropIdleTimeout Constant to indicate the property Idle Timeout.
static java.lang.String	PropMaxTimeout Constant to indicate the property Maximum Timeout.
static java.lang.String	PropParentRealmOid Constant to indicate the property Parent Realm Object Identifier (searchable).
static java.lang.String	PropPersistentSessionType Constant to indicate the property Persistent SessionType.
static java.lang.String	PropProcessAuthEvents Constant to indicate the property Process Authentication Events.
static java.lang.String	PropProcessAzEvents Constant to indicate the property Process Authorization Events.
static java.lang.String	PropProtectAll Constant to indicate the property Protect All.
static java.lang.String	PropResourceFilter Constant to indicate the property Resource Filter.
static java.lang.String	PropScheme Constant to indicate the property Authentication Scheme (searchable).
static java.lang.String	PropSelfRegOid Constant to indicate the property Self Registration Object Identifier (searchable).
static java.lang.String	PropSessionDrift Constant to indicate the property Session Drift.
static java.lang.String	PropSyncAudit Constant to indicate the property Synchronous Audit.

Fields inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

PropObjectClassName

Fields inherited from interface com.netegrity.sdk.policyapi.SmDomainObject

PropDomain

Fields inherited from interface com.netegrity.sdk.policyapi.SmObject

ConfigurationClassName, PropDesc, PropName, PropOid

Constructor Summary

SmRealm()
Constructs a Realm object.

SmRealm(java.lang.String szName)
Constructs a Realm object with the specified name.

Method Summary

SmObjId	getAgent() Gets the Object identifier of the agent or the agent group associated with the realm.
SmObjId	getAgentType() Gets the Object identifier of the agent type.
SmObjId	getAzUserDirOid() Gets the Object identifier of the directory where users accessing resources in this realm will be authorized.
int	getIdleTimeout() Gets the amount of time a user can remain authenticated for the protected resources in the realm without interacting with the resources.
int	getMaxTimeout() Gets the maximum amount of time a user can access the protected resources in the realm before the user must re-authenticate.
SmObjId	getParentRealmOid() Gets the Object identifier of the parent realm where this realm will be added.
int	getPersistentSessionType() Finds out whether realm uses standard sessions or persistent sessions.
boolean	getProcessAuthEvents() Finds out whether the rule is triggered when an authentication attempt occurs.
boolean	getProcessAzEvents() Finds out whether the rule is triggered when an authorization attempt occurs.
boolean	getProtectAll() Finds out whether all the resources in the new realm are protected.
java.lang.String	getResourceFilter() Gets the path of the resource filter.
SmObjId	getScheme() Gets the Object identifier of the authentication scheme associated with the realm.
SmObjId	getSelfRegOid() Gets the Object identifier of the registration scheme that registers new users accessing resources in this realm.
int	getSessionDrift() Gets the specified value which determines the maximum period between agent calls to the Policy Server to validate a session.
boolean	getSyncAudit() Finds out whether synchronous auditing is enabled.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setAgent(java.lang.Object agent) Sets the Object identifier of the agent or the agent group associated with the realm.
void	setAgentType(java.lang.Object agentType) Sets the Object identifier of the agent type.
void	setAzUserDirOid(java.lang.Object azUserDirOid) Set the Object identifier of the directory where users accessing resources in this realm will be authorized.
void	setIdleTimeout(int idleTimeout) Sets the amount of time a user can remain authenticated for the protected resources in the realm without interacting with the resources.
void	setMaxTimeout(int maxTimeout) Sets the maximum amount of time a user can access the protected resources in the realm before the user must re-authenticate.
void	setParentRealmOid(java.lang.Object parentRealmOid) Sets the Object identifier of the parent realm where this realm will be added.
void	setPersistentSessionType(int nPersistentSessionType) Set whether realm should use standard sessions or persistent sessions.
void	setProcessAuthEvents(boolean processAuthEvents) Specifies whether the rule is triggered when an authentication attempt occurs.
void	setProcessAzEvents(boolean processAzEvents) Specifies whether the rule is triggered when an authorization attempt occurs.
void	setProtectAll(boolean protectAll) Specifies whether to protect all the resources in the new realm.
void	setResourceFilter(java.lang.String resourceFilter) Sets the path of the resource filter.
void	setScheme(java.lang.Object scheme) Sets the Object identifier of the authentication scheme associated with the realm.
void	setSelfRegOid(java.lang.Object selfRegOid) Sets the Object identifier of the registration scheme that registers new users accessing resources in this realm.
void	setSessionDrift(int nSessionDrift) Sets the value which determines the maximum period between agent calls to the Policy Server to validate a session.
void	setSyncAudit(boolean syncAudit) Specifies whether to enable synchronous auditing.
void	writeProperties(java.util.Hashtable properties) Copies the object properties to the specified hashtable.

Methods inherited from class com.netegrity.sdk.policyapi.SmDomainObjectImpl

getDomain, getDomainName, isDomainObject, isWriteable, setDomain, setDomainName

Methods inherited from class com.netegrity.sdk.policyapi.SmObjectImpl

getDescription, getName, getObjectClassname, getOid, newObject, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netegrity.sdk.policyapi.SmObject

getDescription, getName, getObjectClassname, getOid, setDescription, setName, setObjectClassname, setOid, setOid, toString, writeSearchProperties

Field Detail

PropResourceFilter

public static final java.lang.String PropResourceFilter

Constant to indicate the property Resource Filter.

See Also:

Constant Field Values

PropAgent

public static final java.lang.String PropAgent

Constant to indicate the property Agent (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropAgentType

public static final java.lang.String PropAgentType

Constant to indicate the property Agent Type (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropScheme

public static final java.lang.String PropScheme

Constant to indicate the property Authentication Scheme (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropProcessAuthEvents

public static final java.lang.String PropProcessAuthEvents

Constant to indicate the property Process Authentication Events.

By default, this property is set to true. Note that if this property is true but no policies are bound to authentication events, a decrease in performance may result.

If no polcies are bound to authentication events, set this property to false.

See Also:

Constant Field Values

PropProcessAzEvents

public static final java.lang.String PropProcessAzEvents

Constant to indicate the property Process Authorization Events.

By default, this property is set to true. Note that if this property is true but no policies are bound to authorization events, a decrease in performance may result.

If no polcies are bound to authorization events, set this property to false.

See Also:

Constant Field Values

PropProtectAll

public static final java.lang.String PropProtectAll

Constant to indicate the property Protect All.

See Also:

Constant Field Values

PropSelfRegOid

public static final java.lang.String PropSelfRegOid

Constant to indicate the property Self Registration Object Identifier (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropAzUserDirOid

public static final java.lang.String PropAzUserDirOid

Constant to indicate the property Authorization Directory Object Identifier (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropMaxTimeout

public static final java.lang.String PropMaxTimeout

Constant to indicate the property Maximum Timeout.

See Also:

Constant Field Values

PropIdleTimeout

public static final java.lang.String PropIdleTimeout

Constant to indicate the property Idle Timeout.

See Also:

Constant Field Values

PropParentRealmOid

public static final java.lang.String PropParentRealmOid

Constant to indicate the property Parent Realm Object Identifier (searchable). You can search realm objects based on this property.

See Also:

Constant Field Values

PropSyncAudit

public static final java.lang.String PropSyncAudit

Constant to indicate the property Synchronous Audit.

See Also:

Constant Field Values

PropPersistentSessionType

public static final java.lang.String PropPersistentSessionType

Constant to indicate the property Persistent SessionType.

See Also:

Constant Field Values

PropSessionDrift

public static final java.lang.String PropSessionDrift

Constant to indicate the property Session Drift.

See Also:

Constant Field Values

Constructor Detail

SmRealm

public SmRealm()

Constructs a Realm object. Name and description are not set.

SmRealm

public SmRealm(java.lang.String szName)

Constructs a Realm object with the specified name.

Parameters:

name - Name of the realm.

Method Detail

getResourceFilter

public java.lang.String getResourceFilter()

Gets the path of the resource filter.

Returns:

The path of the resource filter.

setResourceFilter

public void setResourceFilter(java.lang.String resourceFilter)

Sets the path of the resource filter.

Parameters:

resourceFilter - The path of the resource filter.

getAgent

public SmObjId getAgent()

Gets the Object identifier of the agent or the agent group associated with the realm.

Returns:

The Object identifier of the agent or the agent group.

setAgent

public void setAgent(java.lang.Object agent)

Sets the Object identifier of the agent or the agent group associated with the realm.

Parameters:

agent - The Object identifier of the associated agent or the agent group.

getAgentType

public SmObjId getAgentType()

Gets the Object identifier of the agent type.

Returns:

The Object identifier of the agent type.

setAgentType

public void setAgentType(java.lang.Object agentType)

Sets the Object identifier of the agent type.

Parameters:

agentType - The Object identifier of the agent type.

getScheme

public SmObjId getScheme()

Gets the Object identifier of the authentication scheme associated with the realm.

Returns:

The Object identifier of the associated authentication scheme.

setScheme

public void setScheme(java.lang.Object scheme)

Sets the Object identifier of the authentication scheme associated with the realm.

Parameters:

scheme - Object identifier of the authentication scheme.

getProcessAuthEvents

public boolean getProcessAuthEvents()

Finds out whether the rule is triggered when an authentication attempt occurs.

Returns:

true if the rule is triggered on an authentication attempt. false otherwise.

setProcessAuthEvents

public void setProcessAuthEvents(boolean processAuthEvents)

Specifies whether the rule is triggered when an authentication attempt occurs.

Parameters:

processAuthEvents - true if the rule is triggered on an authentication attempt. false otherwise.

getProcessAzEvents

public boolean getProcessAzEvents()

Finds out whether the rule is triggered when an authorization attempt occurs.

Returns:

true if the rule is triggered on an authorization attempt. false otherwise.

setProcessAzEvents

public void setProcessAzEvents(boolean processAzEvents)

Specifies whether the rule is triggered when an authorization attempt occurs.

Parameters:

processAzEvents - true if the rule is triggered on an authorization attempt. false otherwise.

getProtectAll

public boolean getProtectAll()

Finds out whether all the resources in the new realm are protected.

Returns:

true if all the resources in the new realm are protected. false otherwise.

setProtectAll

public void setProtectAll(boolean protectAll)

Specifies whether to protect all the resources in the new realm.

Parameters:

protectAll - true to protect all the resources in the new realm. false otherwise.

getSelfRegOid

public SmObjId getSelfRegOid()

Gets the Object identifier of the registration scheme that registers new users accessing resources in this realm.

Returns:

The Object identifier of the registration scheme.

setSelfRegOid

public void setSelfRegOid(java.lang.Object selfRegOid)

Sets the Object identifier of the registration scheme that registers new users accessing resources in this realm.

Parameters:

selfRegOid - The Object identifier of the registration scheme.

getAzUserDirOid

public SmObjId getAzUserDirOid()

Gets the Object identifier of the directory where users accessing resources in this realm will be authorized.

Returns:

The Object identifier of the authorization directory.

setAzUserDirOid

public void setAzUserDirOid(java.lang.Object azUserDirOid)

Set the Object identifier of the directory where users accessing resources in this realm will be authorized.

Parameters:

azUserDirOid - The Object identifier of the authorization directory.

getMaxTimeout

public int getMaxTimeout()

Gets the maximum amount of time a user can access the protected resources in the realm before the user must re-authenticate.

Returns:

The time in seconds.

setMaxTimeout

public void setMaxTimeout(int maxTimeout)

Sets the maximum amount of time a user can access the protected resources in the realm before the user must re-authenticate.

Parameters:

maxTimeout - The time in seconds.

getIdleTimeout

public int getIdleTimeout()

Gets the amount of time a user can remain authenticated for the protected resources in the realm without interacting with the resources. Users who exceed this time period without interacting with the protected resources must re-authenticate.

Returns:

The time in seconds.

setIdleTimeout

public void setIdleTimeout(int idleTimeout)

Sets the amount of time a user can remain authenticated for the protected resources in the realm without interacting with the resources. Users who exceed this time period without interacting with the protected resources must re-authenticate.

Parameters:

idleTimeout - The time in seconds.

getParentRealmOid

public SmObjId getParentRealmOid()

Gets the Object identifier of the parent realm where this realm will be added.

Returns:

The Object identifier of the parent realm. If the realm being added is the top realm in the realm hierarchy, this method returns the Object identifier of the domain.

setParentRealmOid

public void setParentRealmOid(java.lang.Object parentRealmOid)

Sets the Object identifier of the parent realm where this realm will be added.

Parameters:

parentRealmOid - The Object identifier of the parent realm. If the realm being added is the top realm in the realm hierarchy, set this parameter to the Object identifier of the domain.

getSyncAudit

public boolean getSyncAudit()

Finds out whether synchronous auditing is enabled. When this feature is enabled, users cannot access resources within a realm until their activity has been successfully recorded in the audit logs of both the Policy Server and the Web Agent.

Returns:

true if synchronous auditing is enabled. false otherwise.

setSyncAudit

public void setSyncAudit(boolean syncAudit)

Specifies whether to enable synchronous auditing. When this feature is enabled, users cannot access resources within a realm until their activity has been successfully recorded in the audit logs of both the Policy Server and the Web Agent.

Parameters:

syncAudit - true if the synchronous auditing is enabled. false otherwise.

getPersistentSessionType

public int getPersistentSessionType()

Finds out whether realm uses standard sessions or persistent sessions. If persistent session is selected, the idle timeout must also be set.

Returns:

1 if persistent session is selected 0 otherwise.

setPersistentSessionType

public void setPersistentSessionType(int nPersistentSessionType)

Set whether realm should use standard sessions or persistent sessions. If persistent session is selected, the idle timeout must also be set.

Parameters:

nPersistentSessionType - 1 if persistent session is selected 0 otherwise.

getSessionDrift

public int getSessionDrift()

Gets the specified value which determines the maximum period between agent calls to the Policy Server to validate a session. This setting is disabled by default.

Returns:

if validation period is enabled, time period is returned in seconds. -1 otherwise.

setSessionDrift

public void setSessionDrift(int nSessionDrift)

Sets the value which determines the maximum period between agent calls to the Policy Server to validate a session. This setting is disabled by default.

Parameters:

nSessionDrift - if validation period should be enabled, specify the time period in seconds. -1 otherwise.

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 SmDomainObjectImpl

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 SmDomainObjectImpl

Parameters:

properties - The new properties of the object.