org.identityconnectors.framework.impl.api

Class AbstractConnectorFacade

java.lang.Object

org.identityconnectors.framework.impl.api.AbstractConnectorFacade

All Implemented Interfaces:

org.identityconnectors.framework.api.ConnectorFacade, org.identityconnectors.framework.api.operations.APIOperation, org.identityconnectors.framework.api.operations.AuthenticationApiOp, org.identityconnectors.framework.api.operations.CreateApiOp, org.identityconnectors.framework.api.operations.DeleteApiOp, org.identityconnectors.framework.api.operations.GetApiOp, org.identityconnectors.framework.api.operations.ResolveUsernameApiOp, org.identityconnectors.framework.api.operations.SchemaApiOp, org.identityconnectors.framework.api.operations.ScriptOnConnectorApiOp, org.identityconnectors.framework.api.operations.ScriptOnResourceApiOp, org.identityconnectors.framework.api.operations.SearchApiOp, org.identityconnectors.framework.api.operations.SyncApiOp, org.identityconnectors.framework.api.operations.TestApiOp, org.identityconnectors.framework.api.operations.UpdateApiOp, org.identityconnectors.framework.api.operations.UpdateDeltaApiOp, org.identityconnectors.framework.api.operations.ValidateApiOp

Direct Known Subclasses:

LocalConnectorFacadeImpl, RemoteConnectorFacadeImpl

public abstract class AbstractConnectorFacade
extends Object
implements org.identityconnectors.framework.api.ConnectorFacade

Implements all the methods of the facade.

Field Summary

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

NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
AbstractConnectorFacade(APIConfigurationImpl configuration) Builds up the maps of supported operations and calls.
AbstractConnectorFacade(String configuration, AbstractConnectorInfo connectorInfo) Builds up the maps of supported operations and calls.

Method Summary

Methods

Modifier and Type	Method and Description
org.identityconnectors.framework.common.objects.Uid	addAttributeValues(org.identityconnectors.framework.common.objects.ObjectClass objclass, org.identityconnectors.framework.common.objects.Uid uid, Set<org.identityconnectors.framework.common.objects.Attribute> attrs, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.common.objects.Uid	authenticate(org.identityconnectors.framework.common.objects.ObjectClass objectClass, String username, org.identityconnectors.common.security.GuardedString password, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.common.objects.Uid	create(org.identityconnectors.framework.common.objects.ObjectClass objectClass, Set<org.identityconnectors.framework.common.objects.Attribute> createAttributes, org.identityconnectors.framework.common.objects.OperationOptions options)
protected org.identityconnectors.framework.api.operations.APIOperation	createLoggingProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api, org.identityconnectors.framework.api.operations.APIOperation target) Creates a logging proxy.
protected org.identityconnectors.framework.api.operations.APIOperation	createTimeoutProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api, org.identityconnectors.framework.api.operations.APIOperation target) Creates the timeout proxy for the given operation.
void	delete(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.Uid uid, org.identityconnectors.framework.common.objects.OperationOptions options)
protected APIConfigurationImpl	getAPIConfiguration()
String	getConnectorFacadeKey() Gets the unique generated identifier of this ConnectorFacade.
org.identityconnectors.framework.common.objects.SyncToken	getLatestSyncToken(org.identityconnectors.framework.common.objects.ObjectClass objectClass)
org.identityconnectors.framework.common.objects.ConnectorObject	getObject(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.Uid uid, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.api.operations.APIOperation	getOperation(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api) Return an instance of an API operation.
protected abstract org.identityconnectors.framework.api.operations.APIOperation	getOperationImplementation(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api) Gets the implementation of the given operation.
Set<Class<? extends org.identityconnectors.framework.api.operations.APIOperation>>	getSupportedOperations()
protected org.identityconnectors.framework.api.operations.APIOperation	newAPIOperationProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api, InvocationHandler handler) Creates a new APIOperation proxy given a handler.
org.identityconnectors.framework.common.objects.Uid	removeAttributeValues(org.identityconnectors.framework.common.objects.ObjectClass objclass, org.identityconnectors.framework.common.objects.Uid uid, Set<org.identityconnectors.framework.common.objects.Attribute> attrs, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.common.objects.Uid	resolveUsername(org.identityconnectors.framework.common.objects.ObjectClass objectClass, String username, org.identityconnectors.framework.common.objects.OperationOptions options)
Object	runScriptOnConnector(org.identityconnectors.framework.common.objects.ScriptContext request, org.identityconnectors.framework.common.objects.OperationOptions options)
Object	runScriptOnResource(org.identityconnectors.framework.common.objects.ScriptContext request, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.common.objects.Schema	schema()
org.identityconnectors.framework.common.objects.SearchResult	search(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.filter.Filter filter, org.identityconnectors.framework.common.objects.ResultsHandler handler, org.identityconnectors.framework.common.objects.OperationOptions options)
org.identityconnectors.framework.common.objects.SyncToken	sync(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.SyncToken token, org.identityconnectors.framework.common.objects.SyncResultsHandler handler, org.identityconnectors.framework.common.objects.OperationOptions options)
void	test()
org.identityconnectors.framework.common.objects.Uid	update(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.Uid uid, Set<org.identityconnectors.framework.common.objects.Attribute> attrs, org.identityconnectors.framework.common.objects.OperationOptions options)
Set<org.identityconnectors.framework.common.objects.AttributeDelta>	updateDelta(org.identityconnectors.framework.common.objects.ObjectClass objectClass, org.identityconnectors.framework.common.objects.Uid uid, Set<org.identityconnectors.framework.common.objects.AttributeDelta> attrsDelta, org.identityconnectors.framework.common.objects.OperationOptions options)
void	validate()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractConnectorFacade

public AbstractConnectorFacade(APIConfigurationImpl configuration)

Builds up the maps of supported operations and calls.

AbstractConnectorFacade

public AbstractConnectorFacade(String configuration,
                       AbstractConnectorInfo connectorInfo)

Builds up the maps of supported operations and calls.

Method Detail

getOperation

public final org.identityconnectors.framework.api.operations.APIOperation getOperation(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api)

Return an instance of an API operation.

Specified by:

getOperation in interface org.identityconnectors.framework.api.ConnectorFacade

Returns:

null if the operation is not support otherwise return an instance of the operation.

See Also:

ConnectorFacade.getOperation(java.lang.Class)

getConnectorFacadeKey

public final String getConnectorFacadeKey()

Gets the unique generated identifier of this ConnectorFacade. It's not guaranteed that the equivalent configuration will generate the same configuration key. Always use the generated value and maintain it in the external application.

Specified by:

getConnectorFacadeKey in interface org.identityconnectors.framework.api.ConnectorFacade

Returns:

identifier of this ConnectorFacade instance.

getSupportedOperations

public final Set<Class<? extends org.identityconnectors.framework.api.operations.APIOperation>> getSupportedOperations()

Specified by:

getSupportedOperations in interface org.identityconnectors.framework.api.ConnectorFacade

schema

public final org.identityconnectors.framework.common.objects.Schema schema()

Specified by:

schema in interface org.identityconnectors.framework.api.operations.SchemaApiOp

create

public final org.identityconnectors.framework.common.objects.Uid create(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                         Set<org.identityconnectors.framework.common.objects.Attribute> createAttributes,
                                                         org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

create in interface org.identityconnectors.framework.api.operations.CreateApiOp

delete

public final void delete(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
          org.identityconnectors.framework.common.objects.Uid uid,
          org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

delete in interface org.identityconnectors.framework.api.operations.DeleteApiOp

search

public final org.identityconnectors.framework.common.objects.SearchResult search(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                                  org.identityconnectors.framework.common.objects.filter.Filter filter,
                                                                  org.identityconnectors.framework.common.objects.ResultsHandler handler,
                                                                  org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

search in interface org.identityconnectors.framework.api.operations.SearchApiOp

update

public final org.identityconnectors.framework.common.objects.Uid update(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                         org.identityconnectors.framework.common.objects.Uid uid,
                                                         Set<org.identityconnectors.framework.common.objects.Attribute> attrs,
                                                         org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

update in interface org.identityconnectors.framework.api.operations.UpdateApiOp

updateDelta

public final Set<org.identityconnectors.framework.common.objects.AttributeDelta> updateDelta(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                                              org.identityconnectors.framework.common.objects.Uid uid,
                                                                              Set<org.identityconnectors.framework.common.objects.AttributeDelta> attrsDelta,
                                                                              org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

updateDelta in interface org.identityconnectors.framework.api.operations.UpdateDeltaApiOp

addAttributeValues

public final org.identityconnectors.framework.common.objects.Uid addAttributeValues(org.identityconnectors.framework.common.objects.ObjectClass objclass,
                                                                     org.identityconnectors.framework.common.objects.Uid uid,
                                                                     Set<org.identityconnectors.framework.common.objects.Attribute> attrs,
                                                                     org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

addAttributeValues in interface org.identityconnectors.framework.api.operations.UpdateApiOp

removeAttributeValues

public final org.identityconnectors.framework.common.objects.Uid removeAttributeValues(org.identityconnectors.framework.common.objects.ObjectClass objclass,
                                                                        org.identityconnectors.framework.common.objects.Uid uid,
                                                                        Set<org.identityconnectors.framework.common.objects.Attribute> attrs,
                                                                        org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

removeAttributeValues in interface org.identityconnectors.framework.api.operations.UpdateApiOp

authenticate

public final org.identityconnectors.framework.common.objects.Uid authenticate(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                               String username,
                                                               org.identityconnectors.common.security.GuardedString password,
                                                               org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

authenticate in interface org.identityconnectors.framework.api.operations.AuthenticationApiOp

resolveUsername

public final org.identityconnectors.framework.common.objects.Uid resolveUsername(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                                  String username,
                                                                  org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

resolveUsername in interface org.identityconnectors.framework.api.operations.ResolveUsernameApiOp

runScriptOnConnector

public final Object runScriptOnConnector(org.identityconnectors.framework.common.objects.ScriptContext request,
                          org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

runScriptOnConnector in interface org.identityconnectors.framework.api.operations.ScriptOnConnectorApiOp

runScriptOnResource

public final Object runScriptOnResource(org.identityconnectors.framework.common.objects.ScriptContext request,
                         org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

runScriptOnResource in interface org.identityconnectors.framework.api.operations.ScriptOnResourceApiOp

getObject

public final org.identityconnectors.framework.common.objects.ConnectorObject getObject(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                                        org.identityconnectors.framework.common.objects.Uid uid,
                                                                        org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

getObject in interface org.identityconnectors.framework.api.operations.GetApiOp

test

public final void test()

Specified by:

test in interface org.identityconnectors.framework.api.operations.TestApiOp

validate

public final void validate()

Specified by:

validate in interface org.identityconnectors.framework.api.operations.ValidateApiOp

sync

public final org.identityconnectors.framework.common.objects.SyncToken sync(org.identityconnectors.framework.common.objects.ObjectClass objectClass,
                                                             org.identityconnectors.framework.common.objects.SyncToken token,
                                                             org.identityconnectors.framework.common.objects.SyncResultsHandler handler,
                                                             org.identityconnectors.framework.common.objects.OperationOptions options)

Specified by:

sync in interface org.identityconnectors.framework.api.operations.SyncApiOp

getLatestSyncToken

public final org.identityconnectors.framework.common.objects.SyncToken getLatestSyncToken(org.identityconnectors.framework.common.objects.ObjectClass objectClass)

Specified by:

getLatestSyncToken in interface org.identityconnectors.framework.api.operations.SyncApiOp

newAPIOperationProxy

protected org.identityconnectors.framework.api.operations.APIOperation newAPIOperationProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api,
                                                                                InvocationHandler handler)

Creates a new APIOperation proxy given a handler.

getOperationImplementation

protected abstract org.identityconnectors.framework.api.operations.APIOperation getOperationImplementation(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api)

Gets the implementation of the given operation.

Parameters:

api - The operation to implement.

Returns:

The implementation

getAPIConfiguration

protected final APIConfigurationImpl getAPIConfiguration()

createTimeoutProxy

protected final org.identityconnectors.framework.api.operations.APIOperation createTimeoutProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api,
                                                                              org.identityconnectors.framework.api.operations.APIOperation target)

Creates the timeout proxy for the given operation.

Parameters:

api - The operation

target - The underlying object

Returns:

The proxy

createLoggingProxy

protected final org.identityconnectors.framework.api.operations.APIOperation createLoggingProxy(Class<? extends org.identityconnectors.framework.api.operations.APIOperation> api,
                                                                              org.identityconnectors.framework.api.operations.APIOperation target)

Creates a logging proxy.

Parameters:

api - The operation

target - The underlying object

Returns:

The proxy