com.adobe.idp.um.spi.authentication
Interface AuthProvider

public interface AuthProvider

The AuthProvider interface is the primary interface that your authentication service provider must implement.

This interface defines the authenticate method that processes authentication information sent from User Management. This interface also defines several constants that represent the names of the properties used to specify the authentication information and represent the results of the authentication.

The implementation of this interface should support only user name and password authentication. To see an object of this type used in a code example, see the Creating Authentication Providers section in Programming with LiveCycle ES4.

Field Summary

static java.lang.String	AUTH_OPTIONS Represents the additional authentication parameters required by the individual authentication provider.
static java.lang.String	AUTH_TYPE Represents the type of authentication mechanism that should be used to process the given authentication parameters.
static java.lang.String	CERTIFICATE_PKCS7_SIGNATURE Represents the signature property of the certificate authentication scheme of a User Management user account.
static java.lang.String	CERTIFICATE_UNSIGNED_DATA Represents the unsigned data property of the certificate authentication scheme of a User Management user account.
static java.lang.String	CONTEXT Represents a context property that authentication service providers should ignore.
static java.lang.String	ENCODED_KERBEROS_TICKET Represents a Kerberos property that authentication service providers should ignore.
static java.lang.String	PASSWORD Represents the password property of a User Management user account.
static java.lang.String	USER_NAME Represents the user name property of a User Management user account.

Method Summary

AuthResponse	authenticate(java.util.Map credential, java.util.List authConfigs) Provides the authentication results for the given authentication parameters.
java.lang.String	getConfigName() Provides the name of the configuration node whose first-level children are extracted from the configuration file.

Field Detail

USER_NAME

static final java.lang.String USER_NAME

Represents the user name property of a User Management user account.

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

Represents the password property of a User Management user account.

See Also:

Constant Field Values

ENCODED_KERBEROS_TICKET

static final java.lang.String ENCODED_KERBEROS_TICKET

Represents a Kerberos property that authentication service providers should ignore.

See Also:

Constant Field Values

CERTIFICATE_UNSIGNED_DATA

static final java.lang.String CERTIFICATE_UNSIGNED_DATA

Represents the unsigned data property of the certificate authentication scheme of a User Management user account.

See Also:

Constant Field Values

CERTIFICATE_PKCS7_SIGNATURE

static final java.lang.String CERTIFICATE_PKCS7_SIGNATURE

Represents the signature property of the certificate authentication scheme of a User Management user account.

See Also:

Constant Field Values

AUTH_TYPE

static final java.lang.String AUTH_TYPE

Represents the type of authentication mechanism that should be used to process the given authentication parameters.

See Also:

Constant Field Values

AUTH_OPTIONS

static final java.lang.String AUTH_OPTIONS

Represents the additional authentication parameters required by the individual authentication provider.

See Also:

Constant Field Values

CONTEXT

static final java.lang.String CONTEXT

Represents a context property that authentication service providers should ignore.

The only valid value for this property is AuthScheme.AUTHTYPE_USERNAME_PWD.

See Also:

Constant Field Values

Method Detail

authenticate

AuthResponse authenticate(java.util.Map credential,
                          java.util.List authConfigs)

Provides the authentication results for the given authentication parameters. The implementation of this method should support the processing of user names and passwords of User Management user accounts. The implementation should not process parameters meant for authentication schemes that are not based on user names and passwords. If a different type of authentication parameters is provided, the implementation should respond with an indication that the parameters were not understood.

This method does not throw exceptions. However, the implementation should include error information in the returned results.

Parameters:

credential - A java.util.Map object that contains the set of property-value pairs needed to authenticate a user. This parameter provides values for the properties that the constant fields of this interface define. The only valid value for the AuthProvider.AUTH_TYPE property is AuthScheme.AUTHTYPE_USERNAME_PWD. If no value is provided for AuthProvider.AUTH_TYPE, AuthScheme.AUTHTYPE_USERNAME_PWD is used by default.

authConfigs - A java.util.List object that contains the configuration information.

Returns:

An AuthResponse object that contains the results of the authentication, or null if the result is unknown. The results can also provide information about any errors that occurred during authentication and an indication that the provided value of AuthProvider.AUTH_TYPE was not valid.

See Also:

AuthProvider.USER_NAME, AuthProvider.PASSWORD, AuthProvider.ENCODED_KERBEROS_TICKET, AuthProvider.AUTH_TYPE, AuthProvider.CONTEXT

getConfigName

java.lang.String getConfigName()

Provides the name of the configuration node whose first-level children are extracted from the configuration file. Valid return values depend on the provider being used.

Returns:

A java.lang.String containing the name of the parent node whose children are to be extracted.