Package org.identityconnectors.framework.api

The Connector API presents a consistent view of any Connector, regardless of which operations the connector actually implements.

See: Description

Package org.identityconnectors.framework.api Description

The Connector API presents a consistent view of any Connector, regardless of which operations the connector actually implements. Common code implements the API in terms of the SPI, providing consistent behavior and common features. The developer of each Connector bundle implements (some subset of) the SPI, and thus inherits a certain amount of common behavior "for free".

For example, the common code that implements the API:

In order to use the Connector API, an application must first use the ConnectorInfoManagerFactory to load a set of connector bundles. Connector bundles can be loaded locally or remotely. In either case, the ConnectorInfoManager that is returned allows the application to obtain an instance of ConnectorInfo that describes each of the available connector bundles.

The application then uses the ConnectorInfo to configure an instance of the connector. The application obtains the default configuration, lists the available configuration properties, and then sets values for configuration properties. Connector configuration properties typically include such target-specific information such as hostname, port number and the username and password to use in connecting to the target. The application then passes the APIConfiguration that it has tailored into ConnectorFacadeFactory.newInstance(org.identityconnectors.framework.api.APIConfiguration) to obtain an instance of ConnectorFacade. An instance of ConnectorFacade represents a configured instance of a connector.

Once the application has an instance of ConnectorFacade, the application can invoke any operation that it supports. In some cases, a connector facade may support certain operations only for certain object-classes. Each instance of ConnectorFacade describes the object-classes and the operations that it supports.

Copyright © 2015. All rights reserved.