Skip navigation links

com.thortech.xl.gc.spi
Interface ProvisioningTransportProvider

public interface ProvisioningTransportProvider

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 transport aspect of provisioning. It would involve extraction of provisioning data from Oracle Identity Manager and transfer it to a target application. Examples of the implementation for this layer would be File Transport Provider, Web Services Provider and JMS Provider.

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, following a neat development approach, it is recommended that you wrap all the possible Exceptions from all internal layers in instances of ProvisioningTransportException. 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 portion for only ProvisioningTransportException and this Exception instance could then be wrapped in ProviderException.

See Also:

ProvisioningFormatProvider, ProviderException, ProvisioningTransportException

Method Summary

TargetSchema	defineMetadata() This method establishes the default metadata definition of identity accounts in the target system.
void	initialize(Provider provider) This method initializes the provider
java.lang.String	sendData(TargetOperation targetOperation) This method sends the formatted provisioning input to the target application and collects the response of the provisioning operation.

Method Detail

initialize

void initialize(Provider provider)
                throws ProviderException

This method initializes the provider

Parameters:

provider - 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

See Also:

Provider

defineMetadata

TargetSchema defineMetadata()
                            throws ProviderException

This method establishes the default metadata definition of identity accounts in the target system. The implementation should have the business logic of automatically defining the metadata of target application identity accounts, parent as well as child (multi-valued).

Returns:

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

Throws:

ProviderException

See Also:

TargetSchema

sendData

java.lang.String sendData(TargetOperation targetOperation)
                          throws ProviderException

This method sends the formatted provisioning input to the target application and collects the response of the provisioning operation.

Parameters:

targetOperation - The output of ProvisioningFormatProvider.formatData(OIMRecord, OIMOperation, AssignmentTarget, ArrayList) which is a value object capturing the formatted provisioning input.

Returns:

Response of the provisioning operation whether success or failure. This value would form as the base input for forming the "response code" to be displayed on Oracle Identity Manager Admin Console. Implementers should consider the fact that these values should exactly coincide with the values defined for the attribute "code" of the element "Response" in Provider xml definition file.

Throws:

ProviderException

See Also:

TargetOperation

Skip navigation links