com.thortech.xl.gc.spi

Interface ProvisioningFormatProvider

public interface ProvisioningFormatProvider

This interface should be implemented by a layer that incorporates provisioning functionalities with a particular type of target application, to be used by a connector created through the generic technology connector. The implementation layer should mainly deal with data format generation and conversion of provisioning data, initially present in Oracle Identity Manager-compatible format (OIMSchema) to a structure according to relevant TargetSchema while provisioning. Examples of the implementation for this layer would be the SPML provider, XML Provider (w.r.t a specific schema), E-Mail provider (w.r.t a specific template), etc. The output of this layer needs to be passed to the corresponding implementation of the ProvisioningTransportProvider interface, which would then parse the extracted data/metadata.

All the methods of this interface throw ProviderException. The implementations of this interface should utilize this fact to wrap all possible exceptions ultimately in an instance of ProviderException. Rich provider implementation layers are expected to be modular with the main implementation methods calling a number of methods, which would be internally invoking more internal layers of business logic. In such a case it is recommended that you wrap all the possible Exceptions from all internal layers in instances of ProvisioningFormatException. The main methods of the implementation (which are actually the ones defined in this interface) would then just have the try-catch blocks with the catch portions for only ReconciliationTransportException and this exception instance could then be wrapped in a ProviderException.

See Also:

ProvisioningTransportProvider, ProviderException, ProvisioningFormatException

Method Summary

Modifier and Type	Method and Description
TargetOperation	formatData(OIMRecord provData, OIMOperation operation, AssignmentTarget assignedTo, java.util.ArrayList list) This method parses the target records and convert them into a structure that Oracle Identity Manager understands.
void	initialize(Provider providerdata) This method initializes the provider
OIMSchema	parseMetadata(TargetSchema schema) This method parses the target schema and return a schema understandable by OIM.

Method Detail

initialize

void initialize(Provider providerdata)
         throws ProviderException

This method initializes the provider

Parameters:

providerdata - A value object that represents a provider instance. It can also be considered as a collection of provider parameter specifications. Provider parameters, runtime as well as design could be obtained from this value object instance. Check the API documentation for Provider for more details.

Throws:

ProviderException

parseMetadata

OIMSchema parseMetadata(TargetSchema schema)
                 throws ProviderException

This method parses the target schema and return a schema understandable by OIM. It is invoked by the generic technology connector framework while metadata detection, and its input is fed by the output of ProvisioningTransportProvider.defineMetadata(). The point to be kep into consideration is metadata detection feature of the generic technology connector gives more priority to an implementation provided by Reconciliation providers (combination of ReconTransportProvider.getMetadata() and ReconFormatProvider.parseMetadata(TargetSchema)). Therefore, if a reconciliation and provisioning connector is created, then the metadata detection implementation offered by reconciliation providers will be invoked first. Only if the invoked implementation does not return any metadata definition, then the provisioning providers metadata definition implementation would be invoked for further utilization.

Parameters:

schema - A value object that represents the schema of an identity record in the target system. Check the API documentation for TargetSchema for more details.

Returns:

A value object that represents the schema of an identity record in Oracle Identity Manager. Check the API documentation for OIMSchema for more details.

Throws:

ProviderException

See Also:

OIMSchema, TargetSchema

formatData

TargetOperation formatData(OIMRecord provData,
                           OIMOperation operation,
                           AssignmentTarget assignedTo,
                           java.util.ArrayList list)
                    throws ProviderException

This method parses the target records and convert them into a structure that Oracle Identity Manager understands. It is invoked by the generic technology connector framework while reconciliation execution, and its input is fed by the output of ReconTransportProvider.getFirstPage(int, String) or ReconTransportProvider.getNextPage(int).

Parameters:

provData - Instance of a value object that represent an identity record in Oracle Identity Manager, to be provisioned to the target application.Check the API documentation for OIMRecord for more details.

operation - Instance of a value object that represent an identity provisioning operation in Oracle Identity Manager Check the API documentation for OIMOperation for more details.

assignedTo - Instance of a value object that represent the task assignment of an identity provisioning operation. Check the API documentation for AssignmentTarget for more details.

list - For an operation that has been invoked on parent data, this ArrayList would be a collection of the fields of the "Account" dataset of "Provisioning Staging". Each member of this ArrayList would be an instance of AttributeWithSource.

For an operation that has been invoked on a child table data, this ArrayList would be a collection of the fields of the relevant child dataset of "Provisioning Staging".

Returns:

Instance of a value object that conforms to the data format in which target system expects input for provisioning operations. Check the API documentation for TargetOperation for more details.

Throws:

ProviderException

See Also:

OIMRecord, OIMOperation, AssignmentTarget, AttributeWithSource, TargetOperation