com.netegrity.sdk.dmsapi
Interface SmDmsApi

All Known Implementing Classes:

SmDmsApiImpl

public interface SmDmsApi

Directory interfaces for the Delegated Mangement Services API.

Since:

SDK 2.0

Field Summary

static int

SMDMSAPI_VERSION_20 Client-supplied constant indicating that DMS operations should comply with version 2.0 of the DMS API.

Method Summary

SmApiResult	getDirectoryContext(SmUserDirectory userDir, 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.

Field Detail

SMDMSAPI_VERSION_20

static final int SMDMSAPI_VERSION_20

Client-supplied constant indicating that DMS operations should comply with version 2.0 of the DMS API.

See Also:

Constant Field Values

Method Detail

getDmsContext

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.

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

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

Throws:

SmApiException

getDirectoryContext

SmApiResult getDirectoryContext(SmUserDirectory userDir,
                                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.

Parameters:

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

dmsConfig - DMS configuration object.

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

Returns:

SmApiResult The result of the API request.

Throws:

SmApiException

getVersion

int getVersion()

Gets the DMS API version compliance level.

Returns:

The DMS API version compliance level.