com.ibm.itim.apps.recon
Class ReconManager

java.lang.Object
  com.ibm.itim.apps.recon.ReconManager

public class ReconManager
extends java.lang.Object

Provides service reconciliation management capabilities, from API. These capabilities include -

• Retrieval of reconciliation units for a service.
• Replace an existing set of reconciliation units for a service by a new set.
• Addition\Removal of a single reconciliation unit for a service.
• Running reconciliation immediately for a given service with an optional call back object. The call back object if specified gains control, after the reconciliation process has completed.
• Retrieve all attribute names of the account profile associated with service, available for reconciliation.
• Check if underlying service supports reconciliation with a filter.
• Retrieval and modification of reconciliation related attributes for a given service.

Note - As a service points to a remote resource, so the terms 'service' and 'resource' are used interchangeably in this documentation.

See Also:

ReconUnitData

Constructor Summary

ReconManager(PlatformContext platform, javax.security.auth.Subject subject)
Constructs the recon manager with a platform context and a subject.

Method Summary

void	addReconUnitData(ServiceMO service, ReconUnitData reconUnitData, IReconCompleteCallback reconCompleteCallback) Adds and configures a reconciliation unit for a resource.
java.util.Collection	getAvailableReconciliationAttributes(ServiceMO service) Returns a collection of attribute names of the account profile, associated with the specified service or resource, that are available on the resource and can be reconciled from the resource.
java.util.Collection	getReconUnits(ServiceMO service) Returns a collection of existing reconciliation units configured for a resource.
boolean	isFilterSupported(ServiceMO service) Returns true if underlying service supports filtered reconciliation that is, the ability to reconcile only a certain set of accounts from the resource, which match an LDAP compliant filter, specified when configuring a reconciliation unit for the resource.
void	removeReconUnitData(ServiceMO service, ReconUnitData reconUnitData) Removes an existing reconciliation unit configured for a resource with the same schedule information as that of the input parameter reconUnitData.
Request	runManualServiceRecon(DistinguishedName serviceDN, boolean supportingDataOnlyRecon, java.lang.String reconAccountData) Runs a full reconciliation immediately for accounts on a manual service or a service with connection mode set to manual.
Request	runRecon(ServiceMO service, ReconUnitData reconUnitData) Runs a reconciliation immediately using the specified reconciliation unit for a given resource.
Request	runRecon(ServiceMO service, ReconUnitData reconUnitData, IReconCompleteCallback reconCallback) Runs a reconciliation immediately using the specified reconciliation unit for a given resource, and a callback object which gains control after the reconciliation process has finished.
void	setReconUnits(ServiceMO service, java.util.Collection reconUnitData) Replaces the existing set of reconciliation units configured for a resource by a new collection of reconciliation units passed as a parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReconManager

public ReconManager(PlatformContext platform,
                    javax.security.auth.Subject subject)

Constructs the recon manager with a platform context and a subject.

Parameters:

platform - PlatformContext holding platform connection information.

subject - Subject representing the authenticated caller.

Method Detail

getReconUnits

public java.util.Collection getReconUnits(ServiceMO service)
                                   throws java.rmi.RemoteException,
                                          ApplicationException,
                                          RemoteServicesException

Returns a collection of existing reconciliation units configured for a resource.

Parameters:

service - ServiceMO representing the service or the resource.

Returns:

A collection of ReconUnitData objects configured for the given resource.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

setReconUnits

public void setReconUnits(ServiceMO service,
                          java.util.Collection reconUnitData)
                   throws java.rmi.RemoteException,
                          ApplicationException,
                          RemoteServicesException

Replaces the existing set of reconciliation units configured for a resource by a new collection of reconciliation units passed as a parameter. Passing an empty collection as a parameter will remove all existing reconciliation units for this resource.

Parameters:

service - ServiceMO representing the service or resource.

reconUnitData - Collection of ReconUnitData objects to configure for the resource.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

addReconUnitData

public void addReconUnitData(ServiceMO service,
                             ReconUnitData reconUnitData,
                             IReconCompleteCallback reconCompleteCallback)
                      throws java.rmi.RemoteException,
                             ApplicationException,
                             RemoteServicesException

Adds and configures a reconciliation unit for a resource.

Parameters:

service - ServiceMO representing the service or resource.

reconUnitData - ReconUnitData object to be added for the resource.

reconCompleteCallback - An object of a class implementing IReconCompleteCallback interface, whose 'onReconComplete' method gets executed after completion of recon process, if it is a not null.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

See Also:

IReconCompleteCallback

removeReconUnitData

public void removeReconUnitData(ServiceMO service,
                                ReconUnitData reconUnitData)
                         throws java.rmi.RemoteException,
                                ApplicationException,
                                RemoteServicesException

Removes an existing reconciliation unit configured for a resource with the same schedule information as that of the input parameter reconUnitData.

Parameters:

service - ServiceMO representing the service or resource.

reconUnitData - ReconUnitData object to be removed. Reconciliation units with same schedule information as that of this parameter will be removed.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

runRecon

public Request runRecon(ServiceMO service,
                        ReconUnitData reconUnitData)
                 throws java.rmi.RemoteException,
                        ApplicationException,
                        RemoteServicesException

Runs a reconciliation immediately using the specified reconciliation unit for a given resource.

Parameters:

service - ServiceMO representing the service or resource.

reconUnitData - ReconUnitData of resource representing an existing reconciliation unit, to use for reconciliation.

Returns:

Request Object representing the reconciliation process status and the the process id.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

runRecon

public Request runRecon(ServiceMO service,
                        ReconUnitData reconUnitData,
                        IReconCompleteCallback reconCallback)
                 throws java.rmi.RemoteException,
                        ApplicationException,
                        RemoteServicesException

Runs a reconciliation immediately using the specified reconciliation unit for a given resource, and a callback object which gains control after the reconciliation process has finished. After the reconciliation process completes the 'onReconComplete' method of this callabck object will be executed.

Parameters:

service - ServiceMO representing the service or resource.

reconUnitData - ReconUnitData of resource representing an existing reconciliation unit, to use for reconciliation.

reconCallback - An object of class implementing IReconCompleteCallback interface whose 'onReconComplete' method gets executed after completion of recon process.

Returns:

Request Object representing the reconciliation process status and the process Id.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

RemoteServicesException - Thrown if unable to find a service provider for the given service.

See Also:

IReconCompleteCallback

runManualServiceRecon

public Request runManualServiceRecon(DistinguishedName serviceDN,
                                     boolean supportingDataOnlyRecon,
                                     java.lang.String reconAccountData)
                              throws java.rmi.RemoteException,
                                     ApplicationException,
                                     com.ibm.itim.authorization.EnroleAuthorizationException,
                                     RemoteServicesException

Runs a full reconciliation immediately for accounts on a manual service or a service with connection mode set to manual. The accounts to be reconciled must be in CSV format.

Parameters:

signedToken - - Specifies a signed object with the DistinguishedName that identifies an authenticated system user.

serviceDN - - The distinguished name of the service to perform reconciliation.

supportingDataOnlyRecon - - A flag that specifies whether this is a supporting data only reconciliation. When set to true it specifies that the reconAccountData only contains supporting data and does not contain account data.

reconAccountData - - The accounts to be reconciled on a manual service.

Throws:

java.rmi.RemoteException - - Thrown when a system exception occurs.

ApplicationException - - Thrown when application-level error occurs.

AuthorizationException - - Thrown if client is unauthorized to perform the operation.

RemoteServicesException - - When the method is unable to find a service provider for the service.

com.ibm.itim.authorization.EnroleAuthorizationException

isFilterSupported

public boolean isFilterSupported(ServiceMO service)
                          throws java.rmi.RemoteException,
                                 ApplicationException,
                                 com.ibm.itim.apps.exception.AppProcessingException

Returns true if underlying service supports filtered reconciliation that is, the ability to reconcile only a certain set of accounts from the resource, which match an LDAP compliant filter, specified when configuring a reconciliation unit for the resource.

Parameters:

service - ServiceMO representing the service or resource.

Returns:

Returns true if filtered reconciliation is supported, else false.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

com.ibm.itim.apps.exception.AppProcessingException - Thrown if unable to execute operation.

getAvailableReconciliationAttributes

public java.util.Collection getAvailableReconciliationAttributes(ServiceMO service)
                                                          throws java.rmi.RemoteException,
                                                                 ApplicationException,
                                                                 com.ibm.itim.apps.exception.AppProcessingException

Returns a collection of attribute names of the account profile, associated with the specified service or resource, that are available on the resource and can be reconciled from the resource.

Parameters:

service - ServiceMO representing the service or resource.

Returns:

Collection of attribute names available for reconciliation for the given resource.

Throws:

java.rmi.RemoteException - Thrown if there is a communication failure.

ApplicationException - Thrown if business rules are violated, while performing requested operation, for example when the user does not have the authority to execute operation.

com.ibm.itim.apps.exception.AppProcessingException - Thrown if unable to execute operation.