Package com.pingidentity.sdk.provision

Interface IdentityStoreUserProvisioner

All Superinterfaces:

ConfigurablePlugin, DescribablePlugin, Plugin

public interface IdentityStoreUserProvisioner
extends Plugin

Deprecated.

Use IdentityStoreProvisioner instead.

The primary Identity Store Provisioner interface. Used to provision and deprovision users to an external user store.

Since:

7.1

Method Summary

Modifier and Type	Method	Description
UserResponseContext	createUser(CreateUserRequestContext createRequestCtx)	Deprecated. Create a user.
void	deleteUser(DeleteUserRequestContext deleteRequestCtx)	Deprecated. Delete a user.
UserResponseContext	readUser(ReadUserRequestContext readRequestCtx)	Deprecated. Read a user.
UserResponseContext	updateUser(UpdateUserRequestContext updateRequestCtx)	Deprecated. Update a user.

Methods inherited from interface com.pingidentity.sdk.ConfigurablePlugin

configure

Methods inherited from interface com.pingidentity.sdk.DescribablePlugin

getPluginDescriptor

Method Details

createUser

UserResponseContext createUser(CreateUserRequestContext createRequestCtx)
                        throws IdentityStoreException

Deprecated.

Create a user.

At a minimum, the UserResponseContext should contain the following attributes within the user attribute map:

• Constants.ID
• Constants.WHEN_CHANGED - returned as a Date
• Constants.WHEN_CREATED - returned as a Date

Parameters:

createRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. user attributes.

Returns:

A UserResponseContext containing the results of an Identity Store provisioning operation.

Throws:

IdentityStoreException - An exception indicating that the Identity Store Provisioner operation failed.

readUser

UserResponseContext readUser(ReadUserRequestContext readRequestCtx)
                      throws IdentityStoreException

Deprecated.

Read a user.

At a minimum, the UserResponseContext should contain the following attributes within the user attribute map:

• Constants.ID
• Constants.WHEN_CHANGED - returned as a Date
• Constants.WHEN_CREATED - returned as a Date

Parameters:

readRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. user id.

Returns:

A UserResponseContext containing the results of an Identity Store provisioning operation.

Throws:

IdentityStoreException - An exception indicating that the Identity Store Provisioner operation failed.

updateUser

UserResponseContext updateUser(UpdateUserRequestContext updateRequestCtx)
                        throws IdentityStoreException

Deprecated.

Update a user.

At a minimum, the UserResponseContext should contain the following attributes within the user attribute map:

• Constants.ID
• Constants.WHEN_CHANGED - returned as a Date
• Constants.WHEN_CREATED - returned as a Date

Parameters:

updateRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. user attributes.

Returns:

A UserResponseContext containing the results of an Identity Store provisioning operation.

Throws:

IdentityStoreException - An exception indicating that the Identity Store Provisioner operation failed.

deleteUser

void deleteUser(DeleteUserRequestContext deleteRequestCtx)
         throws IdentityStoreException

Deprecated.

Delete a user.

Note: The plugin implementation for deleteUser MAY choose not to permanently delete the user, but MUST return a NotFoundException for all readUser, updateUser, and deleteUser operations associated with the previously deleted ID. In addition, the plugin MUST not consider the deleted user in conflict calculation. For example, a createUser request for a user with a previously deleted id should NOT throw a ConflictException.

Parameters:

deleteRequestCtx - The Request Context containing all the information needed to fulfill the request, e.g. user id.

Throws:

IdentityStoreException - An exception indicating that the Identity Store Provisioner operation failed.