Skip navigation links

Package org.identityconnectors.framework.api

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


Interface Summary
APIConfiguration Interface to show the configuration properties from both the SPI/API based on the Connector makeup.
ConfigurationProperties Encapsulates the Configuration at the SPI layer and uses reflection to identify the individual properties that are available for an application to manipulate.
ConfigurationProperty Represents at the API level a property of a Connector's Configuration at the SPI layer.
ConnectorFacade Main interface through which an application invokes Connector operations.
ConnectorInfo The connector meta-data for a given connector.
ConnectorInfoManager Maintains a list of ConnectorInfo instances, each of which describes a connector that is available.


Class Summary
ConfigurationFilter ConfigurationFilter offers easy way to filter the ConfigurationProperty by the following; object class names(see ObjectClass) operations (see APIOperation) attribute names

The filter accepts ConfigurationProperty if:
the property object class is specific to filter object class OR not specific to any object class AND the property operation is specific to filter operation OR not specific to any operation AND the property attribute is specific to filter attribute OR not specific to any attribute

Since the object is immutable, you need to use ConfigurationFilterBuilder to create an instance.

ConfigurationFilterBuilder Builder for ConfigurationFilter objects.
ConnectorFacadeFactory Allows an application to obtain a connector instance.
ConnectorInfoManagerFactory An application's primary entry point into connectors.
ConnectorKey Uniquely identifies a connector within an installation.
RemoteFrameworkConnectionInfo Encapsulates all the connection information used to connect to a remote instance of the connector framework.


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.

Skip navigation links

Copyright © 2013, Oracle and/or its affiliates. All rights reserved.