com.netegrity.llsdk6.imsapi.provider
Interface ProvisioningSynchronizationProvider

public interface ProvisioningSynchronizationProvider

Interface used by the provisioning synchronization to find, create and delete provisioning users and find corporate users when necessary.

The implementing class should have a default constructor (no parameters). Once an adapter is implemented, it can be referenced for a given environment by adding the user defined property "provisioning.synchronize.provider" with the fully qualified classname as the value. If the property is not specified, Identity Manager uses a default provider to create and delete provisioning users as part of the inbound/outbound synchronization process.

Since:

IdentityMinder 8.1 CR003

Method Summary

void	createCorporateUser(User provisioningUser, User corporateUser) Create a corporate user for a given provisioning user.
void	createProvisioningUser(java.lang.Object ctx, User corporateUser, User provisioningUser) Create a provisioning user for a given corporate user.
boolean	deleteProvisioningUser(java.lang.Object ctx, User corporateUser, User provisioningUser) Delete a provisioning user for a given corporate user
User	getCorporateDirectoryUserForDelete(java.lang.String uniqueName, java.lang.String friendlyName, UserProvider corporateProv) Returns the corporate user for a given provisioning user for the purpose of deletion.
User	getCorporateUser(User provisioningUser, UserProvider corporateProv, AttributeRightsCollection attrs) Returns the corporate user that a given provisoning user should map to.
User	getProvisioningUser(User corporateUser, UserProvider provisioningProv, AttributeRightsCollection attrs) Returns the provisioning user that a given corporate user should map to.

Method Detail

getProvisioningUser

User getProvisioningUser(User corporateUser,
                         UserProvider provisioningProv,
                         AttributeRightsCollection attrs)
                         throws SmApiException

Returns the provisioning user that a given corporate user should map to. The implementation of this method uses the UserProvider passed in to find the provisioning user. An exception is thrown if no user is found.

The general contract of getProvisioningUser is:

• Calling getCorporateUser for the found provisioning user returns a value that can be used to find the original user in the corporate directory

Parameters:

corporateUser -

provisioningProv - The user provider for the provisionig directory

attrs - The attributes to return for the user

Returns:

Throws:

SmApiException

NoSuchobjectException

getCorporateUser

User getCorporateUser(User provisioningUser,
                      UserProvider corporateProv,
                      AttributeRightsCollection attrs)
                      throws SmApiException

Returns the corporate user that a given provisoning user should map to. The implementation of this method uses the UserProvider passed in to find the corporate user. An exception is thrown if no user is found.

The general contract of getCorporateUser is:

• Calling getProvisioningUser for the found corporate user returns a value that can be used to find the original user in the provisioning directory

Parameters:

provisioningUser -

corporateProv - The user provider for the corporate directory

attrs - The attributes to return for the user

Returns:

Throws:

SmApiException

NoSuchobjectException

createProvisioningUser

void createProvisioningUser(java.lang.Object ctx,
                            User corporateUser,
                            User provisioningUser)
                            throws SmApiException,
                                   IAMException

Create a provisioning user for a given corporate user. This method is responsible for generating a friendly name for the user and calling modifyObject on the provisioning user to persist the user once it has made any changes to the values of the provisioning user that are desired.

Parameters:

ctx - A context object associated with the create

corporateUser -

provisioningUser - This represents the provisioning user that will be created initialized with the values the outbound synchronization listener thinks it should contain. Note that the password in particular is not set.

Throws:

IAMException

SmApiException

deleteProvisioningUser

boolean deleteProvisioningUser(java.lang.Object ctx,
                               User corporateUser,
                               User provisioningUser)
                               throws SmApiException,
                                      IAMException

Delete a provisioning user for a given corporate user

Parameters:

ctx - A context object associated with the delete

corporateUser -

provisioningUser -

Returns:

boolean indicating if the provisioning user was deleted

Throws:

IAMException

SmApiException

createCorporateUser

void createCorporateUser(User provisioningUser,
                         User corporateUser)
                         throws SmApiException

Create a corporate user for a given provisioning user. This method is responsible for generating a friendly name for the user and make any changes to the values of the corporate user that are desired. The organization for the corporate user can also be changed before creating the user if the corporate directory is organization based. It is important that the modifyObject is not called on the corporate user here.

Parameters:

provisioningUser -

corporateUser - This represents the corporate user that will be created initialized with the values the inbound synchronization thinks it should contain.

Throws:

SmApiException

getCorporateDirectoryUserForDelete

User getCorporateDirectoryUserForDelete(java.lang.String uniqueName,
                                        java.lang.String friendlyName,
                                        UserProvider corporateProv)
                                        throws SmApiException

Returns the corporate user for a given provisioning user for the purpose of deletion. Since the provisioning user is generally already deleted by the time this method is invoked, only the unique name and friendly name of the provisioning user are available to locate the corporate user. If this is insufficient information to locate the corporate user, the implementor should generally not map the inbound delete event and just return null in this method in case it is still invoked.

Parameters:

uniqueName -

friendlyName -

corporateProv - The user provider for the corporate directory

Returns:

Throws:

SmApiException

NoSuchobjectException