Oracle® Fusion Middleware .NET API Reference for Identity Connector Framework  E57662-01
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | List of all members
Org.IdentityConnectors.Framework.Spi.Operations.ResolveUsernameOp Interface Reference

Inherits Org.IdentityConnectors.Framework.Spi.Operations.SPIOperation.

Public Member Functions

Uid ResolveUsername (ObjectClass objectClass, String username, OperationOptions options)
 This is a companion to the simple Org.IdentityConnectors.Framework.Spi.Operations.AuthenticateOp with two parameters presumed to be user name and password. More...
 

Member Function Documentation

Uid Org.IdentityConnectors.Framework.Spi.Operations.ResolveUsernameOp.ResolveUsername ( ObjectClass  objectClass,
String  username,
OperationOptions  options 
)

This is a companion to the simple Org.IdentityConnectors.Framework.Spi.Operations.AuthenticateOp with two parameters presumed to be user name and password.

The difference is that this method does not try to authenticate the credentials; instead, it return the Uid of the username that would be authenticated.

If the authentication fails the developer should throw a type of Exception either ArgumentException or if a native exception is available and if its of type Exception simple throw it. If the native exception is not a Exception wrap it in one and throw it. This will provide the most detail for logging problem and failed attempts.

The developer is of course encourage to try and throw the most informative exception as possible. In that regards there are several exceptions provided in the exceptions package. For instance one of the most common is Org.IdentityConnectors.Framework.Common.Exceptions.InvalidPasswordException.

Parameters
objectClassThe object class to use for authenticate. Will typically be an account. Will not be null.
usernamethe username that would be authenticated. Will not be null.
optionsadditional options that impact the way this operation is run. If the caller passes null, the framework will convert this into an empty set of options, so SPI need not worry about this ever being null.
Returns
Uid The uid of the account that would be authenticated.
Exceptions
Exceptioniff native authentication fails. If a native exception is available attempt to throw it.
The documentation for this interface was generated from the following file: