Package org.identityconnectors.framework.api

Interface ConnectorFacade

All Superinterfaces:
APIOperation, AuthenticationApiOp, BatchApiOp, ConnectorEventSubscriptionApiOp, CreateApiOp, DeleteApiOp, GetApiOp, ResolveUsernameApiOp, SchemaApiOp, ScriptOnConnectorApiOp, ScriptOnResourceApiOp, SearchApiOp, SyncApiOp, SyncEventSubscriptionApiOp, TestApiOp, UpdateApiOp, ValidateApiOp
public interface ConnectorFacade extends BatchApiOp, CreateApiOp, DeleteApiOp, SearchApiOp, UpdateApiOp, SchemaApiOp, AuthenticationApiOp, ResolveUsernameApiOp, GetApiOp, ValidateApiOp, TestApiOp, ScriptOnConnectorApiOp, ScriptOnResourceApiOp, SyncApiOp, ConnectorEventSubscriptionApiOp, SyncEventSubscriptionApiOp
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
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.

    • isOperational

      default boolean isOperational()
      Return whether this ConnectorFacade is operational.
      Returns:
      true if operational, otherwise false