Package org.identityconnectors.framework.api
For example, the common code that implements the API:
- Provides connection pooling to each Connector that requires it.
Not every Connector needs connection pooling,
but those that do can "opt-in" simply by implementing
a specific interface
. The calling application that uses the API does not need to do anything in order to enable connection pooling, but canconfigure connection pooling
. - Provides timeouts for all Connector operations. Common code provides this transparently to each implementation of the SPI. The API consumer may configure an appropriate timeout if the default is unacceptable.
- Provides default implementations of advanced operations.
A Connector developer may implement either simple or advanced versions
of certain
SPI operations
such as update or search. The API consumer sees only the advanced version of such operations, regardless of which version the Connector developer implements.
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
.
-
Interface Summary Interface Description APIConfiguration Interface to show the configuration properties from both the SPI/API based on theConnector
makeup.ConfigurationProperties Encapsulates theConfiguration 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'sConfiguration 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 ofConnectorInfo
instances, each of which describes a connector that is available. -
Class Summary Class Description ConnectorFacadeFactory Allows an application to obtain aconnector 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.ResultsHandlerConfiguration SPI search operation has a defaultResultsHandler
-chain as: NormalizingResultsHandler FilteredResultsHandler AttributesToGetSearchResultsHandler This configuration allow to overconfigure the chain.