Package org.identityconnectors.framework.api

Interface ConnectorFacade

All Superinterfaces:
APIOperation, AuthenticationApiOp, CreateApiOp, DeleteApiOp, DiscoverConfigurationApiOp, GetApiOp, LiveSyncApiOp, ResolveUsernameApiOp, SchemaApiOp, ScriptOnConnectorApiOp, ScriptOnResourceApiOp, SearchApiOp, SyncApiOp, TestApiOp, UpdateApiOp, UpdateDeltaApiOp, ValidateApiOp
All Known Implementing Classes:
AbstractConnectorFacade, LocalConnectorFacadeImpl, RemoteConnectorFacadeImpl
public interface ConnectorFacade extends CreateApiOp, DeleteApiOp, SearchApiOp, UpdateApiOp, UpdateDeltaApiOp, SchemaApiOp, AuthenticationApiOp, ResolveUsernameApiOp, GetApiOp, ValidateApiOp, TestApiOp, ScriptOnConnectorApiOp, ScriptOnResourceApiOp, SyncApiOp, LiveSyncApiOp, DiscoverConfigurationApiOp
Main interface through which an application invokes Connector operations. Represents at the API level a specific instance of a Connector that has been configured in a specific way.
Since:
1.0
Author:
Will Droste
See Also:

  • Method Details

    • getConnectorFacadeKey

      String getConnectorFacadeKey()
      Gets the unique generated identifier of this ConnectorFacade. It's not guarantied that the equivalent configuration will generate the same configuration key. Always use the generated value and maintain it in the external application.
      Returns:
      identifier of this ConnectorFacade instance.
      Since:
      1.4

    • getSupportedOperations

      Set<Class<? extends APIOperation>> getSupportedOperations()
      Get the set of operations that this ConnectorFacade will support.

    • getOperation

      APIOperation getOperation(Class<? extends APIOperation> clazz)
      Get an instance of an operation that this facade supports.

    • dispose

      void dispose()
      Dispose of any resources associated with this facade (except for facade classes). This will dispose of any connector instances in the connector pool. The purpose of this method is to reduce resource waste for connectors that are no longer used. But it can also be used to implement "logout and login" functionality for connectors, e.g. in cases when server-side configuration has changed and the operator needs to force closing and re-opening of all connector connections.
      Since:
      1.5.0.0