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:

ConnectorFacadeFactory

Field Summary

Fields inherited from interface org.identityconnectors.framework.api.operations.APIOperation

NO_TIMEOUT

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConnectorFacadeKey()	Gets the unique generated identifier of this ConnectorFacade.
APIOperation	getOperation(java.lang.Class<? extends APIOperation> clazz)	Get an instance of an operation that this facade supports.
java.util.Set<java.lang.Class<? extends APIOperation>>	getSupportedOperations()	Get the set of operations that this ConnectorFacade will support.
default boolean	isOperational()	Return whether this ConnectorFacade is operational.

Methods inherited from interface org.identityconnectors.framework.api.operations.AuthenticationApiOp

authenticate

Methods inherited from interface org.identityconnectors.framework.api.operations.BatchApiOp

executeBatch, queryBatch

Methods inherited from interface org.identityconnectors.framework.api.operations.ConnectorEventSubscriptionApiOp

subscribe

Methods inherited from interface org.identityconnectors.framework.api.operations.CreateApiOp

create

Methods inherited from interface org.identityconnectors.framework.api.operations.DeleteApiOp

delete

Methods inherited from interface org.identityconnectors.framework.api.operations.GetApiOp

getObject

Methods inherited from interface org.identityconnectors.framework.api.operations.ResolveUsernameApiOp

resolveUsername

Methods inherited from interface org.identityconnectors.framework.api.operations.SchemaApiOp

schema

Methods inherited from interface org.identityconnectors.framework.api.operations.ScriptOnConnectorApiOp

runScriptOnConnector

Methods inherited from interface org.identityconnectors.framework.api.operations.ScriptOnResourceApiOp

runScriptOnResource

Methods inherited from interface org.identityconnectors.framework.api.operations.SearchApiOp

search

Methods inherited from interface org.identityconnectors.framework.api.operations.SyncApiOp

getLatestSyncToken, sync

Methods inherited from interface org.identityconnectors.framework.api.operations.SyncEventSubscriptionApiOp

subscribe

Methods inherited from interface org.identityconnectors.framework.api.operations.TestApiOp

test

Methods inherited from interface org.identityconnectors.framework.api.operations.UpdateApiOp

addAttributeValues, removeAttributeValues, update

Methods inherited from interface org.identityconnectors.framework.api.operations.ValidateApiOp

validate

Method Detail

getConnectorFacadeKey

java.lang.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

java.util.Set<java.lang.Class<? extends APIOperation>> getSupportedOperations()

Get the set of operations that this ConnectorFacade will support.

getOperation

APIOperation getOperation(java.lang.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