Delegated Management Services API › Write a Directory Management Application

Write a Directory Management Application

To write a Directory Management application

1. Establish a Connection to the Policy Server
2. Obtain a Session Object

   A session object is obtained when a user or administrator successfully logs in:

   • To log in a SiteMinder administrator and establish a SiteMinder administrator session, call the login() method in the SmApiSession class of the Utilities package.

     If login is successful, the session object contains the session specification.

   • To log in an end user, DMS organization administrator, or DMS super administrator, call the login() method in the AgentAPI class of the Agent API package.

     If the login is successful, the session specification is put into the spec field of the SessionDef object. Set the spec value in the SmApiSession object.

3. Pass in the Session Object

   After obtaining a valid session, create a DMS API object by passing the session to the constructor of the SmDmsApiImpl class—for example:

   SmDmsApi dmsApi = new SmDmsApiImpl (apiSession);
   

   In the example, dmsApi is the new DMS API object, and apiSession is the session obtained when the administrator successfully logged in.

   Note: Whenever you create a DMS API object, you pass the session and connection information to the object.

4. Create a Directory Management Context

   To use the DMS API to access a user directory, you need to know either:

   • The OID of a realm that has a self-registration scheme configured for it.

     Call SmDmsApiImpl.getDmsContext() to pass in this information.

   • The SiteMinder user directory where you are operating.

     Call SmDmsApiImpl.getDirectoryContext() to pass in this information.

     The type of information you know or choose to provide determines the directory management context for accessing the user directory, as follows:

     If You Know...	And...	Then Use...
     The OID of a realm that contains a self-registration scheme	The user is a SiteMinder administrator	Delegated Management Services (DMS) context
     The SiteMinder user directory name or OID	—	Directory context

     DMS context and directory context provide two different avenues for reaching the same destination—an SmDmsDirectory object where you can access and manipulate directory information.

     The following figure illustrates the process flow of the DMS API through a context object:

     

     Once you choose the context information you want to provide, you create the context.

5. Create and Manipulate Objects

After creating a context, you can create and manipulate directory objects using the DMS Object Model. When working with directory objects, you need to know:

• The distinguished name of the object.
• The type of object, such as:
  • Top-level organization
  • Organizational unit
  • Group
  • User
  • Role