com.netegrity.sdk.dmsapi
Class SmDmsDirectory

java.lang.Object
  com.netegrity.sdk.dmsapi.SmDmsObject
      com.netegrity.sdk.dmsapi.SmDmsDirectory

public final class SmDmsDirectory
extends SmDmsObject

Represents a user namespace, such as LDAP.

See getDirType() for a list of supported directories.

Since:

SDK 2.0

Field Summary

static int	CAPABILITY_ANONYMOUSID_ATTR Read-Write anonymous ID user attribute is configured for the directory.
static int	CAPABILITY_CHALLENGERESP_ATTR Read-Write Challenge and Response user attribute is configured for the directory.
static int	CAPABILITY_CHANGE_USERPASSWORD Capable of changing user password.
static int	CAPABILITY_CREATE_PASSWORDPOLICY Capable of supporting SiteMinder password policy.
static int	CAPABILITY_CREATE_REGISTRATIONPOLICY Capable of creating registration policy.
static int	CAPABILITY_DISABLE_USER Capable of disabling user account.
static int	CAPABILITY_DISABLED_ATTR Read-Write disabled user attribute is configured for the directory.
static int	CAPABILITY_DMSCAPABLE Capable of supporting DMS.
static int	CAPABILITY_EMAILADDRESS_ATTR Read only e-mail user attribute is configured for the directory.
static int	CAPABILITY_PAGING Capable of paging.
static int	CAPABILITY_PASSWORDDATA_ATTR Read-Write password data user attribute is configured for the directory.
static int	CAPABILITY_RECURSIVE Capable of supporting recursion (nested groups, etc).
static int	CAPABILITY_RESET_USERPASSWORD Capable of resetting a user password.
static int	CAPABILITY_SORTING Capable of sorting.
static int	CAPABILITY_UNIVERSALID_ATTR Read-only universal ID user attribute is configured for the directory.
static int	CAPABILITY_USERPASSWORD_ATTR Read-Write password user attribute is configured for the directory.

Fields inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

DMSOBJECT_CLASS_DIRECTORY, DMSOBJECT_CLASS_GROUP, DMSOBJECT_CLASS_ORGANIZATION, DMSOBJECT_CLASS_ROLE, DMSOBJECT_CLASS_UNKNOWN, DMSOBJECT_CLASS_USER

Constructor Summary

SmDmsDirectory(SmApiSession apiSession, SmRealm realm, SmUserDirectory userDirectory, SmDmsConfig dmsConfig)
Creates an SmDmsDirectory object with a valid session (SmApiSession), realm (SmRealm), user directory (SmUserDirectory), and DMS configuration (SmDmsConfig).

Method Summary

SmApiResult	getCapabilities(java.util.Vector capabilities) Gets directory capabilities.
SmApiResult	getCapabilitiesNoAdminCheck(java.util.Vector capabilities)
java.lang.String	getDirType() Gets the type of the underlying directory.
SmApiResult	getDmsRoles(java.lang.String szDomainName, java.util.Vector roles) Gets available DMS roles from a domain.
SmApiResult	getDmsRolesNoAdminCheck(java.lang.String szDomainName, java.util.Vector roles)
SmApiResult	getOrganizations(java.util.Vector organizations) Gets first-level organizations.
SmApiResult	getOrganizationsNoAdminCheck(java.util.Vector organizations)
SmRealm	getRealm() Gets a SiteMinder realm.
SmApiResult	getUserChallengeText(java.lang.String filter) Searches for a user and returns a string containing the challenge text stored in the user's profile.
SmApiResult	getUserChallengeTextNoAdminCheck(java.lang.String filter)
SmUserDirectory	getUserDirectory() Gets a SiteMinder user directory.
SmApiResult	getUserTempPassword(java.lang.String filter, java.lang.String challengeResponse) Supplies a response to a challenge and gets a temporary password for the user.
SmApiResult	getUserTempPasswordNoAdminCheck(java.lang.String filter, java.lang.String challengeResponse)
SmDmsOrganization	newOrganization(java.lang.String dn) Creates a new organization object from a distinguished name (DN).

Methods inherited from class com.netegrity.sdk.dmsapi.SmDmsObject

addObject, addObjectNoAdminCheck, addToGroup, addToGroupNoAdminCheck, clearAttributes, deleteObject, deleteObjectNoAdminCheck, getApiSession, getAttribute, getAttributes, getClassId, getDmsConfig, getDn, getGroups, getGroups, getGroupsNoAdminCheck, getGroupsNoAdminCheck, getObject, getObject, getObjectNoAdminCheck, getObjectNoAdminCheck, getOrganizationDn, getVersion, isActiveDir, modifyObject, modifyObjectClass, modifyObjectClassNoAdminCheck, modifyObjectNoAdminCheck, newDmsObject, readAttributes, removeFromGroup, removeFromGroupNoAdminCheck, setActiveDir, setAttribute, setAttributes, setClassId, toString, writeAttributes

Methods inherited from class java.lang.Object

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

Field Detail

CAPABILITY_CREATE_PASSWORDPOLICY

public static final int CAPABILITY_CREATE_PASSWORDPOLICY

Capable of supporting SiteMinder password policy. The following attributes are affected in the SiteMinder user directory: passworddata, disabled, userpassword.

See Also:

Constant Field Values

CAPABILITY_CREATE_REGISTRATIONPOLICY

public static final int CAPABILITY_CREATE_REGISTRATIONPOLICY

Capable of creating registration policy. The following attributes are affected in the SiteMinder user directory: anonymous ID, emailaddress, challengeresp, userpassword.

See Also:

Constant Field Values

CAPABILITY_RESET_USERPASSWORD

public static final int CAPABILITY_RESET_USERPASSWORD

Capable of resetting a user password. The following attributes are affected in the SiteMinder user directory: disabled, userpassword.

See Also:

Constant Field Values

CAPABILITY_CHANGE_USERPASSWORD

public static final int CAPABILITY_CHANGE_USERPASSWORD

Capable of changing user password. The following attribute is affected in the SiteMinder user directory: userpassword.

See Also:

Constant Field Values

CAPABILITY_DISABLE_USER

public static final int CAPABILITY_DISABLE_USER

Capable of disabling user account. The following attribute is affected in the SiteMinder user directory: disabled.

See Also:

Constant Field Values

CAPABILITY_DMSCAPABLE

public static final int CAPABILITY_DMSCAPABLE

Capable of supporting DMS.

See Also:

Constant Field Values

CAPABILITY_RECURSIVE

public static final int CAPABILITY_RECURSIVE

Capable of supporting recursion (nested groups, etc).

See Also:

Constant Field Values

CAPABILITY_SORTING

public static final int CAPABILITY_SORTING

Capable of sorting.

See Also:

Constant Field Values

CAPABILITY_PAGING

public static final int CAPABILITY_PAGING

Capable of paging.

See Also:

Constant Field Values

CAPABILITY_DISABLED_ATTR

public static final int CAPABILITY_DISABLED_ATTR

Read-Write disabled user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_UNIVERSALID_ATTR

public static final int CAPABILITY_UNIVERSALID_ATTR

Read-only universal ID user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_ANONYMOUSID_ATTR

public static final int CAPABILITY_ANONYMOUSID_ATTR

Read-Write anonymous ID user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_PASSWORDDATA_ATTR

public static final int CAPABILITY_PASSWORDDATA_ATTR

Read-Write password data user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_USERPASSWORD_ATTR

public static final int CAPABILITY_USERPASSWORD_ATTR

Read-Write password user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_EMAILADDRESS_ATTR

public static final int CAPABILITY_EMAILADDRESS_ATTR

Read only e-mail user attribute is configured for the directory.

See Also:

Constant Field Values

CAPABILITY_CHALLENGERESP_ATTR

public static final int CAPABILITY_CHALLENGERESP_ATTR

Read-Write Challenge and Response user attribute is configured for the directory.

See Also:

Constant Field Values

Constructor Detail

SmDmsDirectory

public SmDmsDirectory(SmApiSession apiSession,
                      SmRealm realm,
                      SmUserDirectory userDirectory,
                      SmDmsConfig dmsConfig)

Creates an SmDmsDirectory object with a valid session (SmApiSession), realm (SmRealm), user directory (SmUserDirectory), and DMS configuration (SmDmsConfig).

Parameters:

apiSession - Valid API session.

realm - Valid realm.

userDirectory - Valid user directory.

dmsConfig - DMS configuration object.

Method Detail

getRealm

public SmRealm getRealm()

Gets a SiteMinder realm. For SmDmsDirectoryContext, the realm object will contain a predefined SiteMinder null object identifier.

Overrides:

getRealm in class SmDmsObject

Returns:

SiteMinder realm.

getUserDirectory

public SmUserDirectory getUserDirectory()

Gets a SiteMinder user directory.

Overrides:

getUserDirectory in class SmDmsObject

Returns:

SiteMinder user directory.

getCapabilities

public SmApiResult getCapabilities(java.util.Vector capabilities)
                            throws SmApiException

Gets directory capabilities.

The value of the integer that is set is an attribute mask of the user directory profile attributes. The valid attribute masks are defined as constants that start with CAPABILITY_ and are described in the Field Detail section of this class.

This method requires an end user session or higher.

Parameters:

capabilities - Vector containing a single java.lang.Integer object.

Returns:

SmApiResult

Throws:

SmApiException

getCapabilitiesNoAdminCheck

public SmApiResult getCapabilitiesNoAdminCheck(java.util.Vector capabilities)
                                        throws SmApiException

Throws:

SmApiException

getDmsRoles

public SmApiResult getDmsRoles(java.lang.String szDomainName,
                               java.util.Vector roles)
                        throws SmApiException

Gets available DMS roles from a domain.

This method requires an organization administrator session or higher.

Parameters:

szDomainName - Name of a domain.

roles - Vector containing a list of DMS role names.

Returns:

SmApiResult

Throws:

SmApiException

getDmsRolesNoAdminCheck

public SmApiResult getDmsRolesNoAdminCheck(java.lang.String szDomainName,
                                           java.util.Vector roles)
                                    throws SmApiException

Throws:

SmApiException

newOrganization

public SmDmsOrganization newOrganization(java.lang.String dn)
                                  throws SmApiException

Creates a new organization object from a distinguished name (DN). If the DN is empty, the DN is set to the directory's search root.

Parameters:

dn - DN of the organization.

Returns:

DMS organization.

Throws:

SmApiException

getOrganizations

public SmApiResult getOrganizations(java.util.Vector organizations)
                             throws SmApiException

Gets first-level organizations.

Parameters:

organizations - Vector containing organization DNs (String).

Returns:

Result of this request.

Throws:

SmApiException

getOrganizationsNoAdminCheck

public SmApiResult getOrganizationsNoAdminCheck(java.util.Vector organizations)
                                         throws SmApiException

Throws:

SmApiException

getUserChallengeText

public SmApiResult getUserChallengeText(java.lang.String filter)
                                 throws SmApiException

Searches for a user and returns a string containing the challenge text stored in the user's profile.

If the request succeeds, the message field of the result will contain the challenge text.

This method requires a super administrator session.

Parameters:

filter - String containing the search filter (String).

Returns:

SmApiResult Result of the request.

Throws:

SmApiException

getUserChallengeTextNoAdminCheck

public SmApiResult getUserChallengeTextNoAdminCheck(java.lang.String filter)
                                             throws SmApiException

Throws:

SmApiException

getUserTempPassword

public SmApiResult getUserTempPassword(java.lang.String filter,
                                       java.lang.String challengeResponse)
                                throws SmApiException

Supplies a response to a challenge and gets a temporary password for the user.

If the request succeeds, the message field of the result will contain the temporary password.

This method requires a super administrator session.

Parameters:

filter - String containing the search filter (String).

challengeResponse - The response to the challenge.

Returns:

SmApiResult Result of the request.

Throws:

SmApiException

getUserTempPasswordNoAdminCheck

public SmApiResult getUserTempPasswordNoAdminCheck(java.lang.String filter,
                                                   java.lang.String challengeResponse)
                                            throws SmApiException

Throws:

SmApiException

getDirType

public java.lang.String getDirType()

Gets the type of the underlying directory.

Returns:

One of the following namespace values:

• LDAP:
• ODBC:

Since:

SDK 2.2