com.netegrity.sdk.policyapi
Class SmUserPolicy

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

All Implemented Interfaces:

SmDomainObject, SmObject, java.lang.Cloneable

public final class SmUserPolicy
extends SmDomainObjectImpl

Represents a SiteMinder User Policy.

This object has domain scope.

Since:

SDK 2.0

Field Summary

static int	DIRECTORY_CLASS Constant to indicate that the policy object is located in the specified directory.
static int	DN_ATTRIBUTE_CLASS Constant to indicate that the policy object is policy-related to any DN matching the specified filter.
static int	GROUP_ATTRIBUTE_CLASS Constant to indicate that the policy object is policy-related to a "group"-like DN matching the specified filter.
static int	GROUP_CLASS Constant to indicate that the policy object is a member (directly, or indirectly through another group) of the specified user group object.
static int	ORG_ATTRIBUTE_CLASS Constant to indicate that the policy object is policy-related to a "org"-like DN matching the specified filter.
static int	ORG_CLASS Constant to indicate that the policy object is a member (directly or indirectly through another organization) of the specified organization object (this supports organizations and organization units).
static java.lang.String	PropFilterClass Constant to indicate the property Filter Class.
static java.lang.String	PropFilterPath Constant to indicate the property Filter Path (searchable).
static java.lang.String	PropPolicy Constant to indicate the property Policy (searchable).
static java.lang.String	PropPolicyFlags Constant to indicate the property Flags.
static java.lang.String	PropPolicyResolution Constant to indicate the property Policy Resolution.
static java.lang.String	PropUserDirectory Constant to indicate the property User Directory (searchable).
static int	QUERY_CLASS Constant to indicate that the policy object is contained in the result set of a directory-specific query.
static int	ROLE_CLASS Constant to indicate that the policy object is the occupant of the specified role.
static int	UNKNOWN_CLASS Constant to indicate that the policy resolution is unknown.
static int	USER_ATTRIBUTE_CLASS Constant to indicate that the policy object matches the specified filter (user scope).
static int	USER_CLASS Constant to indicate that the policy object is the specified user object.

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

SmUserPolicy()
Constructs the user policy object.

Method Summary

java.lang.String	getDescription() Returns null for user policy objects.
java.lang.String	getFilterClass() Gets the filter class of the user policy.
java.lang.String	getFilterPath() Gets the filter path of the user policy.
java.lang.String	getName() Returns null for user policy objects.
SmObjId	getPolicy() Gets the object identifier of the policy associated with the user policy.
int	getPolicyFlags() Gets a bitmask that determines policy behavior regarding user exclusion and recursive policies.
int	getPolicyResolution() Gets the policy resolution of the object.
SmObjId	getUserDirectory() Gets the object identifier of the user directory associated with the user policy.
void	readProperties(java.util.Hashtable properties) Copies the object properties from the specified hashtable.
void	setDescription(java.lang.String description) Sets the description of the object to null.
void	setFilterClass(java.lang.String filterClass) Sets the filter class of the user policy.
void	setFilterPath(java.lang.String filterPath) Sets the filter path of the user policy.
void	setName(java.lang.String name) Sets the name of the object to null.
void	setPolicy(java.lang.Object policy) Sets the object identifier of the policy associated with the user policy.
void	setPolicyFlags(int policyFlags) Sets a bitmask that determines policy behavior regarding user exclusion and recursive policies.
void	setPolicyResolution(int policyResolution) Set the policy resolution of the user policy.
void	setUserDirectory(java.lang.Object userDirectory) Sets the object identifier of the user directory associated with the user policy.
java.lang.String	toString() Returns the filter path of the user policy.
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

getObjectClassname, getOid, newObject, setObjectClassname, setOid, setOid, 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

getObjectClassname, getOid, setObjectClassname, setOid, setOid, writeSearchProperties

Field Detail

PropUserDirectory

public static final java.lang.String PropUserDirectory

Constant to indicate the property User Directory (searchable). You can search user policy objects based on this property.

See Also:

Constant Field Values

PropPolicy

public static final java.lang.String PropPolicy

Constant to indicate the property Policy (searchable). You can search user policy objects based on this property.

See Also:

Constant Field Values

PropFilterPath

public static final java.lang.String PropFilterPath

Constant to indicate the property Filter Path (searchable). You can search user policy objects based on this property.

See Also:

Constant Field Values

PropFilterClass

public static final java.lang.String PropFilterClass

Constant to indicate the property Filter Class.

See Also:

Constant Field Values

PropPolicyResolution

public static final java.lang.String PropPolicyResolution

Constant to indicate the property Policy Resolution. A Policy Resolution property describes how one policy object, such as a user, is related to another policy object, such as a group.

See Also:

Constant Field Values

PropPolicyFlags

public static final java.lang.String PropPolicyFlags

Constant to indicate the property Flags.

See Also:

Constant Field Values

UNKNOWN_CLASS

public static final int UNKNOWN_CLASS

Constant to indicate that the policy resolution is unknown.

See Also:

Constant Field Values

USER_CLASS

public static final int USER_CLASS

Constant to indicate that the policy object is the specified user object.

See Also:

Constant Field Values

GROUP_CLASS

public static final int GROUP_CLASS

Constant to indicate that the policy object is a member (directly, or indirectly through another group) of the specified user group object.

See Also:

Constant Field Values

USER_ATTRIBUTE_CLASS

public static final int USER_ATTRIBUTE_CLASS

Constant to indicate that the policy object matches the specified filter (user scope).

See Also:

Constant Field Values

ROLE_CLASS

public static final int ROLE_CLASS

Constant to indicate that the policy object is the occupant of the specified role.

See Also:

Constant Field Values

ORG_CLASS

public static final int ORG_CLASS

Constant to indicate that the policy object is a member (directly or indirectly through another organization) of the specified organization object (this supports organizations and organization units).

See Also:

Constant Field Values

QUERY_CLASS

public static final int QUERY_CLASS

Constant to indicate that the policy object is contained in the result set of a directory-specific query.

See Also:

Constant Field Values

DIRECTORY_CLASS

public static final int DIRECTORY_CLASS

Constant to indicate that the policy object is located in the specified directory.

See Also:

Constant Field Values

GROUP_ATTRIBUTE_CLASS

public static final int GROUP_ATTRIBUTE_CLASS

Constant to indicate that the policy object is policy-related to a "group"-like DN matching the specified filter.

See Also:

Constant Field Values

ORG_ATTRIBUTE_CLASS

public static final int ORG_ATTRIBUTE_CLASS

Constant to indicate that the policy object is policy-related to a "org"-like DN matching the specified filter.

See Also:

Constant Field Values

DN_ATTRIBUTE_CLASS

public static final int DN_ATTRIBUTE_CLASS

Constant to indicate that the policy object is policy-related to any DN matching the specified filter.

See Also:

Constant Field Values

Constructor Detail

SmUserPolicy

public SmUserPolicy()

Constructs the user policy object. Name and description are not set. User policies do not have a a name associated with the object.

Method Detail

getName

public java.lang.String getName()

Returns null for user policy objects. These objects don't have a name property.

Specified by:

getName in interface SmObject

Overrides:

getName in class SmObjectImpl

Returns:

null.

setName

public void setName(java.lang.String name)

Sets the name of the object to null. User policy objects don't have a name property.

Specified by:

setName in interface SmObject

Overrides:

setName in class SmObjectImpl

Parameters:

name - The name of the object.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the object to null. User policy objects don't have a description property

Specified by:

setDescription in interface SmObject

Overrides:

setDescription in class SmObjectImpl

Parameters:

name - The description of the object.

getDescription

public java.lang.String getDescription()

Returns null for user policy objects. These objects don't have a description property.

Specified by:

getDescription in interface SmObject

Overrides:

getDescription in class SmObjectImpl

Returns:

null.

toString

public java.lang.String toString()

Returns the filter path of the user policy.

Specified by:

toString in interface SmObject

Overrides:

toString in class SmObjectImpl

Returns:

The filter path of the user policy.

getFilterPath

public java.lang.String getFilterPath()

Gets the filter path of the user policy. The filter path contains the user distinguished name.

Returns:

The filter path of the user policy.

setFilterPath

public void setFilterPath(java.lang.String filterPath)

Sets the filter path of the user policy. The filter path contains the user distinguished name.

Parameters:

filterPath - The filter path of the user policy.

getFilterClass

public java.lang.String getFilterClass()

Gets the filter class of the user policy.

Returns:

The filter class of the user policy.

setFilterClass

public void setFilterClass(java.lang.String filterClass)

Sets the filter class of the user policy.

Parameters:

filterClass - The filter class of the user policy.

getPolicyResolution

public int getPolicyResolution()

Gets the policy resolution of the object. A policy resolution describes how one policy object, such as a user, is related to another policy object, such as a group.

Returns:

One of the following values:

 UNKNOWN_CLASS = 0
 USER_CLASS = 1
 GROUP_CLASS = 2
 USER_ATTRIBUTE_CLASS = 3
 ROLE_CLASS = 4
 ORG_CLASS  = 5
 QUERY_CLASS = 6
 DIRECTORY_CLASS = 7
 GROUP_ATTRIBUTE_CLASS = 8
 ORG_ATTRIBUTE_CLASS  = 9
 DN_ATTRIBUTE_CLASS = 10
 

setPolicyResolution

public void setPolicyResolution(int policyResolution)

Set the policy resolution of the user policy. A policy resolution describes how one policy object, such as a user, is related to another policy object, such as a group.

Parameters:

policyResolution - One of the following values:

 UNKNOWN_CLASS = 0
 USER_CLASS = 1
 GROUP_CLASS = 2
 USER_ATTRIBUTE_CLASS = 3
 ROLE_CLASS = 4
 ORG_CLASS  = 5
 QUERY_CLASS = 6
 DIRECTORY_CLASS = 7
 GROUP_ATTRIBUTE_CLASS = 8
 ORG_ATTRIBUTE_CLASS  = 9
 DN_ATTRIBUTE_CLASS = 10
 

getPolicyFlags

public int getPolicyFlags()

Gets a bitmask that determines policy behavior regarding user exclusion and recursive policies. The following flags are returned:

• Bit 0x01 determines whether the user policy excludes users rather than includes them, as follows:
  • 0x01. Policy behavior exclude mask.
  • 0x00. Policy behavior does not exclude users.
  • 0x01. Policy behavior excludes users.
• Bit 0x02 determines whether the user policy is recursive -- for example, whether nested groups should be supported:
  • 0x02. Policy behavior recursive mask.
  • 0x00. Policy behavior is not recursive.
  • 0x02. Policy behavior is recursive.
• Bit 0x04 determines whether the user policies in the user directory are in AND relationship -- for example, whether AND user policies should be supported.
  • 0x04. Policy behavior with AND user policies relationship.
  • 0x00. Policy behavior does not have AND relationship between user policies.
  • 0x04. Policy behavior does have AND relationship between user policies.

Returns:

User policy flags.

setPolicyFlags

public void setPolicyFlags(int policyFlags)

Sets a bitmask that determines policy behavior regarding user exclusion and recursive policies. The following flags can be set:

• Bit 0x01 determines whether the user policy excludes users rather than includes them, as follows:
  • 0x01. Policy behavior exclude mask.
  • 0x00. Policy behavior does not exclude users.
  • 0x01. Policy behavior excludes users.
• Bit 0x02 determines whether the user policy is recursive -- for example, whether nested groups should be supported:
  • 0x02. Policy behavior recursive mask.
  • 0x00. Policy behavior is not recursive.
  • 0x02. Policy behavior is recursive.
• Bit 0x04 determines whether the user policies in the user directory are in AND relationship -- for example, whether AND user policies should be supported.
  • 0x04. Policy behavior with AND user policies relationship.
  • 0x00. Policy behavior does not have AND relationship between user policies.
  • 0x04. Policy behavior does have AND relationship between user policies.

Parameters:

policy - flags User policy flags.

getUserDirectory

public SmObjId getUserDirectory()

Gets the object identifier of the user directory associated with the user policy.

Returns:

The object identifier of the associated user directory.

setUserDirectory

public void setUserDirectory(java.lang.Object userDirectory)

Sets the object identifier of the user directory associated with the user policy.

Parameters:

userDirectory - The object identifier of the associated user directory.

getPolicy

public SmObjId getPolicy()

Gets the object identifier of the policy associated with the user policy.

Returns:

The object identifier of the associated policy.

setPolicy

public void setPolicy(java.lang.Object policy)

Sets the object identifier of the policy associated with the user policy.

Parameters:

policy - The object identifier of the associated policy.

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.