com.netegrity.sdk.dmsapi
Class SmDmsApiImpl

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

All Implemented Interfaces:

SmDmsApi

public class SmDmsApiImpl
extends java.lang.Object
implements SmDmsApi

This is the implementation class of the interface SmDmsApi. Use this class as the starting point for the Delegated Management API. For background information about Delegated Management, see the Programming Guide for Java.

This class lets you determine how you want to access the information in the SmDmsDirectory object. You can do so by providing either of two kinds of information:

• The name or OID of the target user directory. To provide this information, call getDirectoryContext().
  
  
• The OID of the protected realm that the user is attempting to access. To provide this information, call getDmsContext().

Before creating an object of this class, you need to have a valid SmApiSession object.

Since:

SDK 2.0

Field Summary

Fields inherited from interface com.netegrity.sdk.dmsapi.SmDmsApi

SMDMSAPI_VERSION_20

Constructor Summary

SmDmsApiImpl(SmApiSession apiSession)
Creates an SmDmsApiImpl object with a valid session (SmApiSession).

SmDmsApiImpl(SmApiSession apiSession, int version)
Creates an SmDmsApiImpl object with a valid session (SmApiSession) and a specified DMS API version compliance level.

Method Summary

SmApiResult	getDirectoryContext(SmUserDirectory userDirectory, SmDmsConfig dmsConfig, SmDmsDirectoryContext dirContext) Creates a new user directory context.
SmApiResult	getDmsContext(SmRealm realm, SmDmsConfig dmsConfig, SmDmsContext dmsContext) Creates a new DMS context.
SmApiResult	getDmsContextNoAdminCheck(SmRealm realm, SmDmsConfig dmsConfig, SmDmsContext dmsContext)
int	getVersion() Gets the DMS API version compliance level.
void	setApiSession(SmApiSession apiSession) Sets the API session object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SmDmsApiImpl

public SmDmsApiImpl(SmApiSession apiSession)

Creates an SmDmsApiImpl object with a valid session (SmApiSession).

This constructor chooses the default version SMDMSAPI_VERSION_20.

Parameters:

apiSession - Valid SiteMinder API session object.

SmDmsApiImpl

public SmDmsApiImpl(SmApiSession apiSession,
                    int version)

Creates an SmDmsApiImpl object with a valid session (SmApiSession) and a specified DMS API version compliance level.

Parameters:

apiSession - Valid SiteMinder API session object.

version - The client's DMS API version compliance level. Valid DMS API compliance level constants are defined in the SmDmsApi interface. These constants are prefixed with SMDMSAPI_VERSION_.

Method Detail

setApiSession

public void setApiSession(SmApiSession apiSession)

Sets the API session object.

Parameters:

apiSession - Valid SiteMinder API session object.

getDmsContext

public SmApiResult getDmsContext(SmRealm realm,
                                 SmDmsConfig dmsConfig,
                                 SmDmsContext dmsContext)
                          throws SmApiException

Creates a new DMS context.

To create a new DMS context, you need to know the realm object identifier.

This method requires a SiteMinder administrator session.

Specified by:

getDmsContext in interface SmDmsApi

Parameters:

realm - The registration realm with a valid object identifier.

dmsConfig - DMS configuration object.

dmsContext - DMS context object that will be filled by this method.

Returns:

SmApiResult The result of the API request.

Throws:

SmApiException

getDmsContextNoAdminCheck

public SmApiResult getDmsContextNoAdminCheck(SmRealm realm,
                                             SmDmsConfig dmsConfig,
                                             SmDmsContext dmsContext)
                                      throws SmApiException

Specified by:

getDmsContextNoAdminCheck in interface SmDmsApi

Throws:

SmApiException

getDirectoryContext

public SmApiResult getDirectoryContext(SmUserDirectory userDirectory,
                                       SmDmsConfig dmsConfig,
                                       SmDmsDirectoryContext dirContext)
                                throws SmApiException

Creates a new user directory context.

To create a directory context, you need to know the name or object identifier of the directory where you will be operating.

This method requires an end user session or higher.

Specified by:

getDirectoryContext in interface SmDmsApi

Parameters:

userDirectory - User directory object with a valid name or object identifier.

dmsConfig - DMS configuration object.

dirContext - Directory context object that will be filled by this method.

Returns:

SmApiResult The result of the API request.

Throws:

SmApiException

getVersion

public int getVersion()

Gets the DMS API version compliance level.

Specified by:

getVersion in interface SmDmsApi

Returns:

The DMS API version compliance level.