org.forgerock.openicf.framework.remote

Class RemoteAsyncConnectorFacade

java.lang.Object

org.identityconnectors.framework.impl.api.AbstractConnectorFacade

org.forgerock.openicf.framework.remote.RemoteAsyncConnectorFacade

All Implemented Interfaces:

AsyncConnectorFacade, AuthenticationAsyncApiOp, CreateAsyncApiOp, DeleteAsyncApiOp, GetAsyncApiOp, ResolveUsernameAsyncApiOp, SchemaAsyncApiOp, ScriptOnConnectorAsyncApiOp, ScriptOnResourceAsyncApiOp, TestAsyncApiOp, UpdateAsyncApiOp, ValidateAsyncApiOp, ConnectorFacade, APIOperation, AuthenticationApiOp, BatchApiOp, ConnectorEventSubscriptionApiOp, CreateApiOp, DeleteApiOp, GetApiOp, ResolveUsernameApiOp, SchemaApiOp, ScriptOnConnectorApiOp, ScriptOnResourceApiOp, SearchApiOp, SyncApiOp, SyncEventSubscriptionApiOp, TestApiOp, UpdateApiOp, ValidateApiOp

public class RemoteAsyncConnectorFacade
extends AbstractConnectorFacade
implements AsyncConnectorFacade

Field Summary

Fields inherited from class org.identityconnectors.framework.impl.api.AbstractConnectorFacade

MSG

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

NO_TIMEOUT

Constructor Summary

Constructors

Modifier	Constructor and Description
	RemoteAsyncConnectorFacade(APIConfigurationImpl configuration)
protected	RemoteAsyncConnectorFacade(APIConfigurationImpl configuration, org.forgerock.util.Function<LoadBalancingConnectorFacadeContext,APIConfiguration,RuntimeException> transformer)
	RemoteAsyncConnectorFacade(RemoteConnectorInfoImpl firstConnectorInfo, org.forgerock.util.Function<LoadBalancingConnectorFacadeContext,APIConfiguration,RuntimeException> transformer)

Method Summary

Modifier and Type	Method and Description
org.forgerock.util.promise.Promise<Uid,RuntimeException>	addAttributeValuesAsync(ObjectClass objectClass, Uid uid, Set<Attribute> valuesToAdd, OperationOptions options) Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided.
org.forgerock.util.promise.Promise<Uid,RuntimeException>	authenticateAsync(ObjectClass objectClass, String username, GuardedString password, OperationOptions options) Most basic authentication available.
org.forgerock.util.promise.Promise<Uid,RuntimeException>	createAsync(ObjectClass objectClass, Set<Attribute> createAttributes, OperationOptions options) Create a target object based on the specified attributes.
<T extends APIOperation> T	createLogging(Class<? extends APIOperation> api, T target)
org.forgerock.util.promise.Promise<Void,RuntimeException>	deleteAsync(ObjectClass objectClass, Uid uid, OperationOptions options) Delete the object that the specified Uid identifies (if any).
protected <T extends APIOperation> T	getAsyncOperationCheckSupported(Class<T> api)
org.forgerock.util.promise.Promise<ConnectorObject,RuntimeException>	getObjectAsync(ObjectClass objectClass, Uid uid, OperationOptions options) Get a particular ConnectorObject based on the Uid.
protected APIOperation	getOperationImplementation(Class<? extends APIOperation> api) Gets the implementation of the given operation.
org.forgerock.util.promise.Promise<Uid,RuntimeException>	removeAttributeValuesAsync(ObjectClass objectClass, Uid uid, Set<Attribute> valuesToRemove, OperationOptions options) Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.
org.forgerock.util.promise.Promise<Uid,RuntimeException>	resolveUsernameAsync(ObjectClass objectClass, String username, OperationOptions options) Resolve the given authentication username to the corresponding Uid.
org.forgerock.util.promise.Promise<Object,RuntimeException>	runScriptOnConnectorAsync(ScriptContext request, OperationOptions options) Runs the script.
org.forgerock.util.promise.Promise<Object,RuntimeException>	runScriptOnResourceAsync(ScriptContext request, OperationOptions options) Runs a script on a specific target resource.
org.forgerock.util.promise.Promise<Schema,RuntimeException>	schemaAsync() Retrieve the basic schema of this Connector.
org.forgerock.util.promise.Promise<Void,RuntimeException>	testAsync() Tests the Configuration with the connector.
org.forgerock.util.promise.Promise<Uid,RuntimeException>	updateAsync(ObjectClass objectClass, Uid uid, Set<Attribute> replaceAttributes, OperationOptions options) Update the object specified by the ObjectClass and Uid, replacing the current values of each attribute with the values provided.
org.forgerock.util.promise.Promise<Void,RuntimeException>	validateAsync() Validates the configuration.

Methods inherited from class org.identityconnectors.framework.impl.api.AbstractConnectorFacade

addAttributeValues, authenticate, create, createLoggingProxy, createTimeoutProxy, delete, executeBatch, getAPIConfiguration, getConnectorFacadeKey, getLatestSyncToken, getObject, getOperation, getSupportedOperations, newAPIOperationProxy, queryBatch, removeAttributeValues, resolveUsername, runScriptOnConnector, runScriptOnResource, schema, search, subscribe, subscribe, sync, test, update, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.identityconnectors.framework.api.ConnectorFacade

getConnectorFacadeKey, getOperation, getSupportedOperations

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

executeBatch, queryBatch

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.ConnectorEventSubscriptionApiOp

subscribe

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

subscribe

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

authenticate

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

Constructor Detail

RemoteAsyncConnectorFacade

protected RemoteAsyncConnectorFacade(APIConfigurationImpl configuration,
                                     org.forgerock.util.Function<LoadBalancingConnectorFacadeContext,APIConfiguration,RuntimeException> transformer)

RemoteAsyncConnectorFacade

public RemoteAsyncConnectorFacade(RemoteConnectorInfoImpl firstConnectorInfo,
                                  org.forgerock.util.Function<LoadBalancingConnectorFacadeContext,APIConfiguration,RuntimeException> transformer)

RemoteAsyncConnectorFacade

public RemoteAsyncConnectorFacade(APIConfigurationImpl configuration)

Method Detail

createLogging

public <T extends APIOperation> T createLogging(Class<? extends APIOperation> api,
                                                T target)

getAsyncOperationCheckSupported

protected <T extends APIOperation> T getAsyncOperationCheckSupported(Class<T> api)

getOperationImplementation

protected APIOperation getOperationImplementation(Class<? extends APIOperation> api)

Description copied from class: AbstractConnectorFacade

Gets the implementation of the given operation.

Specified by:

getOperationImplementation in class AbstractConnectorFacade

Parameters:

api - The operation to implement.

Returns:

The implementation

authenticateAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> authenticateAsync(ObjectClass objectClass,
                                                                                  String username,
                                                                                  GuardedString password,
                                                                                  OperationOptions options)

Description copied from interface: AuthenticationAsyncApiOp

Most basic authentication available.

Specified by:

authenticateAsync in interface AuthenticationAsyncApiOp

Parameters:

objectClass - The object class to use for authenticate. Will typically be an account. Must not be null.

username - string that represents the account or user id.

password - string that represents the password for the account or user.

options - additional options that impact the way this operation is run. May be null.

Returns:

Uid The uid of the account that was used to authenticate

createAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> createAsync(ObjectClass objectClass,
                                                                            Set<Attribute> createAttributes,
                                                                            OperationOptions options)

Description copied from interface: CreateAsyncApiOp

Create a target object based on the specified attributes. The Connector framework always requires attribute ObjectClass. The Connector itself may require additional attributes. The API will confirm that the set contains the ObjectClass attribute and that no two attributes in the set have the same name.

Specified by:

createAsync in interface CreateAsyncApiOp

Parameters:

objectClass - the type of object to create. Must not be null.

createAttributes - includes all the attributes necessary to create the target object (including the ObjectClass attribute).

options - additional options that impact the way this operation is run. May be null.

Returns:

the unique id for the object that is created. For instance in LDAP this would be the 'dn', for a database this would be the primary key, and for 'ActiveDirectory' this would be the GUID.

deleteAsync

public org.forgerock.util.promise.Promise<Void,RuntimeException> deleteAsync(ObjectClass objectClass,
                                                                             Uid uid,
                                                                             OperationOptions options)

Description copied from interface: DeleteAsyncApiOp

Delete the object that the specified Uid identifies (if any).

Specified by:

deleteAsync in interface DeleteAsyncApiOp

Parameters:

objectClass - type of object to delete.

uid - The unique id that specifies the object to delete.

options - additional options that impact the way this operation is run. May be null.

getObjectAsync

public org.forgerock.util.promise.Promise<ConnectorObject,RuntimeException> getObjectAsync(ObjectClass objectClass,
                                                                                           Uid uid,
                                                                                           OperationOptions options)

Description copied from interface: GetAsyncApiOp

Get a particular ConnectorObject based on the Uid.

Specified by:

getObjectAsync in interface GetAsyncApiOp

Parameters:

objectClass - type of object to get.

uid - the unique id of the object that to get.

options - additional options that impact the way this operation is run. May be null.

Returns:

ConnectorObject based on the Uid provided or null if no such object could be found.

resolveUsernameAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> resolveUsernameAsync(ObjectClass objectClass,
                                                                                     String username,
                                                                                     OperationOptions options)

Description copied from interface: ResolveUsernameAsyncApiOp

Resolve the given authentication username to the corresponding Uid. The Uid is the one that AuthenticationApiOp.authenticate(org.identityconnectors.framework.common.objects.ObjectClass, java.lang.String, org.identityconnectors.common.security.GuardedString, org.identityconnectors.framework.common.objects.OperationOptions) would return in case of a successful authentication.

Specified by:

resolveUsernameAsync in interface ResolveUsernameAsyncApiOp

Parameters:

objectClass - The object class to use for authenticate. Will typically be an account. Must not be null.

username - string that represents the account or user id.

options - additional options that impact the way this operation is run. May be null.

Returns:

Uid The uid of the account that would be used to authenticate.

schemaAsync

public org.forgerock.util.promise.Promise<Schema,RuntimeException> schemaAsync()

Description copied from interface: SchemaAsyncApiOp

Retrieve the basic schema of this Connector.

Specified by:

schemaAsync in interface SchemaAsyncApiOp

runScriptOnConnectorAsync

public org.forgerock.util.promise.Promise<Object,RuntimeException> runScriptOnConnectorAsync(ScriptContext request,
                                                                                             OperationOptions options)

Description copied from interface: ScriptOnConnectorAsyncApiOp

Runs the script.

Specified by:

runScriptOnConnectorAsync in interface ScriptOnConnectorAsyncApiOp

Parameters:

request - The script and arguments to run.

options - Additional options that control how the script is run. The framework does not currently recognize any options but specific connectors might. Consult the documentation for each connector to identify supported options.

Returns:

The result of the script. The return type must be a type that the framework supports for serialization.

See Also:

for a list of supported return types.

runScriptOnResourceAsync

public org.forgerock.util.promise.Promise<Object,RuntimeException> runScriptOnResourceAsync(ScriptContext request,
                                                                                            OperationOptions options)

Description copied from interface: ScriptOnResourceAsyncApiOp

Runs a script on a specific target resource.

Specified by:

runScriptOnResourceAsync in interface ScriptOnResourceAsyncApiOp

Parameters:

request - The script and arguments to run.

options - Additional options which control how the script is run. Please refer to the connector documentation for supported options.

Returns:

The result of the script. The return type must be a type that the connector framework supports for serialization. See ObjectSerializerFactory for a list of supported return types.

testAsync

public org.forgerock.util.promise.Promise<Void,RuntimeException> testAsync()

Description copied from interface: TestAsyncApiOp

Tests the Configuration with the connector.

Specified by:

testAsync in interface TestAsyncApiOp

updateAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> updateAsync(ObjectClass objectClass,
                                                                            Uid uid,
                                                                            Set<Attribute> replaceAttributes,
                                                                            OperationOptions options)

Description copied from interface: UpdateAsyncApiOp

Update the object specified by the ObjectClass and Uid, replacing the current values of each attribute with the values provided.

For each input attribute, replace all of the current values of that attribute in the target object with the values of that attribute.

If the target object does not currently contain an attribute that the input set contains, then add this attribute (along with the provided values) to the target object.

If the value of an attribute in the input set is null, then do one of the following, depending on which is most appropriate for the target:

• If possible, remove that attribute from the target object entirely.
• Otherwise, replace all of the current values of that attribute in the target object with a single value of null.

Specified by:

updateAsync in interface UpdateAsyncApiOp

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

replaceAttributes - set of new Attribute . the values in this set represent the new, merged values to be applied to the object. This set may also include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

Returns:

the Uid of the updated object in case the update changes the formation of the unique identifier.

addAttributeValuesAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> addAttributeValuesAsync(ObjectClass objectClass,
                                                                                        Uid uid,
                                                                                        Set<Attribute> valuesToAdd,
                                                                                        OperationOptions options)

Description copied from interface: UpdateAsyncApiOp

Update the object specified by the ObjectClass and Uid, adding to the current values of each attribute the values provided.

For each attribute that the input set contains, add to the current values of that attribute in the target object all of the values of that attribute in the input set.

NOTE that this does not specify how to handle duplicate values. The general assumption for an attribute of a ConnectorObject is that the values for an attribute may contain duplicates. Therefore, in general simply append the provided values to the current value for each attribute.

IMPLEMENTATION NOTE: for connectors that merely implement UpdateOp and not UpdateAttributeValuesOp this method will be simulated by fetching, merging, and calling UpdateOp.update(ObjectClass, Uid, Set, OperationOptions) . Therefore, connector implementations are encourage to implement UpdateAttributeValuesOp from a performance and atomicity standpoint.

Specified by:

addAttributeValuesAsync in interface UpdateAsyncApiOp

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

valuesToAdd - set of Attribute deltas. The values for the attributes in this set represent the values to add to attributes in the object. merged. This set must not include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

Returns:

the Uid of the updated object in case the update changes the formation of the unique identifier.

removeAttributeValuesAsync

public org.forgerock.util.promise.Promise<Uid,RuntimeException> removeAttributeValuesAsync(ObjectClass objectClass,
                                                                                           Uid uid,
                                                                                           Set<Attribute> valuesToRemove,
                                                                                           OperationOptions options)

Description copied from interface: UpdateAsyncApiOp

Update the object specified by the ObjectClass and Uid, removing from the current values of each attribute the values provided.

For each attribute that the input set contains, remove from the current values of that attribute in the target object any value that matches one of the values of the attribute from the input set.

NOTE that this does not specify how to handle unmatched values. The general assumption for an attribute of a ConnectorObject is that the values for an attribute are merely representational state. Therefore, the implementer should simply ignore any provided value that does not match a current value of that attribute in the target object. Deleting an unmatched value should always succeed.

IMPLEMENTATION NOTE: for connectors that merely implement UpdateOp and not UpdateAttributeValuesOp this method will be simulated by fetching, merging, and calling UpdateOp.update(ObjectClass, Uid, Set, OperationOptions) . Therefore, connector implementations are encourage to implement UpdateAttributeValuesOp from a performance and atomicity standpoint.

Specified by:

removeAttributeValuesAsync in interface UpdateAsyncApiOp

Parameters:

objectClass - the type of object to modify. Must not be null.

uid - the uid of the object to modify. Must not be null.

valuesToRemove - set of Attribute deltas. The values for the attributes in this set represent the values to remove from attributes in the object. merged. This set must not include operational attributes. Must not be null.

options - additional options that impact the way this operation is run. May be null.

Returns:

the Uid of the updated object in case the update changes the formation of the unique identifier.

validateAsync

public org.forgerock.util.promise.Promise<Void,RuntimeException> validateAsync()

Description copied from interface: ValidateAsyncApiOp

Validates the configuration.

Specified by:

validateAsync in interface ValidateAsyncApiOp