public interface ProvisioningTransportProvider
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.Modifier and Type | Method and Description |
---|---|
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.
|
void initialize(Provider provider) throws ProviderException
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.ProviderException
Provider
TargetSchema defineMetadata() throws ProviderException
TargetSchema
for more details.ProviderException
TargetSchema
java.lang.String sendData(TargetOperation targetOperation) throws ProviderException
targetOperation
- The output of ProvisioningFormatProvider.formatData(OIMRecord, OIMOperation, AssignmentTarget, ArrayList)
which is a value object capturing the formatted provisioning input.ProviderException
TargetOperation