public interface ReconFormatProvider
TargetSchema, to an Oracle Identity Manager-compatible format
OIMSchema, while reconciliation.
Implementation should provide facilities for not only parsing extracted data but also
the detected metadata of the target accounts.Examples of the implementation for this layer would be
CSV File provider, XML Provider (w.r.t a specific schema), E-Mail provider (w.r.t a specific template)
etc. All the input of this layer comes from corresponding implementation of the
ReconTransportProvider interface, which mainly extracts identity account data/metadata from the target
applications.
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 a 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 ReconciliationFormatException. The main methods of the implementation (which
are actually the ones defined in this interface) would then just have the try-catch blocks
with catch portion for only ReconciliationTransportException and this Exception instance
could then be wrapped in a ProviderException.
As far as reconciliation is concerned, there are situations when the ReconTransportProvider
implementation would need to take the responsibility of understanding and parsing the data format for
the target identity accounts. In such cases, the ReconFormatProvider implementation would become
a very simplified layer, just producing the instances of Oracle Identity Manager compliant value objects for data
(OIMRecord) and metadata (OIMSchema).| Modifier and Type | Method and Description |
|---|---|
void |
initialize(Provider providerdata)
This method initializes the provider
|
OIMSchema |
parseMetadata(TargetSchema schema)
This method parses the target schema and returns a schema that Oracle Identity Manager understands.
|
OIMRecord[] |
parseRecords(TargetRecord[] records)
This method parses the target records and converts them into a structure that Oracle Identity Manager understands.
|
void initialize(Provider providerdata) throws ProviderException
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.ProviderExceptionProviderOIMSchema parseMetadata(TargetSchema schema) throws ProviderException
ReconTransportProvider.getMetadata().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.OIMSchema for more details.ProviderExceptionOIMSchema,
TargetSchemaOIMRecord[] parseRecords(TargetRecord[] records) throws ProviderException
ReconTransportProvider.getFirstPage(int, String) or ReconTransportProvider.getNextPage(int).records - An array of value objects that represent identity records in the target system.
Check the API documentation for TargetRecord for more details.OIMRecord for more details.ProviderExceptionOIMRecord,
TargetRecord