org.identityconnectors.framework.api.operations
Interface ResolveUsernameApiOp

All Superinterfaces:

APIOperation

All Known Subinterfaces:

ConnectorFacade

public interface ResolveUsernameApiOp
extends APIOperation

Field Summary

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

NO_TIMEOUT

Method Summary

Uid	resolveUsername(ObjectClass objectClass, String username, OperationOptions options) Resolve the given authentication username to the corresponding Uid.

Method Detail

resolveUsername

Uid resolveUsername(ObjectClass objectClass,
                    String username,
                    OperationOptions options)

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.

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.

Throws:

RuntimeException - iff the username could not be resolved.

Since:

1.1