Package org.identityconnectors.framework.spi
package org.identityconnectors.framework.spi
This is the "Service Provider Interface" package. The
Connector developer
is responsible for implementing the following interfaces to build a Connector.
- First, one must implement the
Configurationinterface. TheConfiguration.validate()method is used to determine whether the configuration information that has been provided is valid. The implementation should simply be a Java Bean. There should be a getter and setter for each configuration property. For instance, if the resource is a database instance then some typical configuration information would include the JDBC driver, the host name of remote machine or the URL, and some connection credentials. The getter should return the default value. - Second, one should implement the
Connectorinterface. This interface insures proper initialization and disposal of theConnector. If theConnectordeveloper would like the API to handle 'Connection Pooling', the Connector must implement thePoolableConnectorinterface. - Third, one should implement all the operations the resource can support, such as
CreateOp,UpdateOp,DeleteOp,SearchOp, etc..
The operations package
has many operations from which to choose. In some cases, one operation does the same thing as another
but exposes more options. For instance there are two update operations.
UpdateOp is simpler to implement than
UpdateAttributeValuesOp.
-
ClassDescriptionConvenient base-class for Configuration objects to extend.Interface to be implemented by connectors that need to normalize certain attributes.Encapsulates the configuration of a connector.The
Configurationinterface is traversed through reflection.TheConfigurationinterface is traversed through reflection.This is the main interface to declare a connector.This annotation must be present on each connector class.To be implemented by connectors that wish to be pooled.A SearchResultsHandler is a completion handler for consuming the results of a search request.A Stateful Configuration interface extends the defaultConfigurationand makes the framework keep the same instance.A SyncTokenResultsHandler is a Callback interface that an application implements in order to handle results fromSyncApiOpin a stream-processing fashion.