com.netegrity.sdk.dmsapi
Class SmDmsConfig

java.lang.Object
  com.netegrity.sdk.dmsapi.SmDmsConfig

public class SmDmsConfig
extends java.lang.Object

Represents a DMS configuration object.

Every DMS request includes an organization DN. The information in the SmDmsConfig object is below that DN in the directory structure.

In the following SiteMinder user directory (shown in the blue box), the organization DN ou=dev,ou=eng,o=swdev.com has four sub DNs, or "containers," with default container names. You can keep the default names or change them, depending on the SmDmsConfig constructor you choose.

Since:

SDK 2.0

Constructor Summary

SmDmsConfig()
Creates a DMS configuration object with default directory structure names.

SmDmsConfig(java.lang.String PeopleSubDn, java.lang.String GroupsSubDn, java.lang.String RolesSubDn, java.lang.String OrgAdminSubDn, java.lang.String OrgAdminOrgs, java.lang.String DnOrgs)
Creates a DMS configuration object with custom directory stucture names.

Method Summary

void	encodeCommand(SmApiObject apiObj) Internal use only.
java.lang.String	getDnOrgs() Returns the attribute name for the list of organizations that a user can belong to.
java.lang.String	getGroupsSubDn() Returns the attribute and container names for groups.
java.lang.String	getOrgAdminOrgs() Returns the attribute name for the list of organizations that an administrator can manage.
java.lang.String	getOrgAdminSubDn() Returns the attribute and container names for organization administrators.
java.lang.String	getPeopleSubDn() Returns the attribute and container names for users.
java.lang.String	getRolesSubDn() Returns the attribute and container names for roles.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmDmsConfig

public SmDmsConfig()

Creates a DMS configuration object with default directory structure names. Default names are as follows:

• ou=people. Attribute and container names for users.
• ou=groups. Attribute and container names for groups.
• ou=roles. Attribute and container names for roles.
• cn=orgadmin. Attribute and container names for organization administrators.
• ou. Attribute name for the list of organizations that an administrator can manage.
• ou. Attribute name for the list of organizations that a user can belong to.

SmDmsConfig

public SmDmsConfig(java.lang.String PeopleSubDn,
                   java.lang.String GroupsSubDn,
                   java.lang.String RolesSubDn,
                   java.lang.String OrgAdminSubDn,
                   java.lang.String OrgAdminOrgs,
                   java.lang.String DnOrgs)

Creates a DMS configuration object with custom directory stucture names.

Parameters:

PeopleSubDn - Attribute and container names for users.

GroupsSubDn - Attribute and container names for groups.

RolesSubDn - Attribute and container names for roles.

OrgAdminSubDn - Attribute and container names for organization administrators.

OrgAdminOrgs - Attribute name for the list of organizations that an administrator can manage.

DnOrgs - Attribute name for the list of organizations that a user can belong to.

Method Detail

encodeCommand

public void encodeCommand(SmApiObject apiObj)

Internal use only.

Parameters:

apiObj - An SmApiObject object in package com.netegrity.sdk.apiutil

getPeopleSubDn

public java.lang.String getPeopleSubDn()

Returns the attribute and container names for users.

getGroupsSubDn

public java.lang.String getGroupsSubDn()

Returns the attribute and container names for groups.

getRolesSubDn

public java.lang.String getRolesSubDn()

Returns the attribute and container names for roles.

getOrgAdminSubDn

public java.lang.String getOrgAdminSubDn()

Returns the attribute and container names for organization administrators.

getOrgAdminOrgs

public java.lang.String getOrgAdminOrgs()

Returns the attribute name for the list of organizations that an administrator can manage.

getDnOrgs

public java.lang.String getDnOrgs()

Returns the attribute name for the list of organizations that a user can belong to.