| Package | com.adobe.idp.um.spi.authentication |
| Interface | public interface AuthProvider |
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.
| Method | Defined by | ||
|---|---|---|---|
|
AuthResponse authenticate(Map credential, List authConfigs)
Provides the authentication results for the given authentication parameters.
| AuthProvider | ||
|
String getConfigName()
Provides the name of the configuration node whose first-level children are extracted from the configuration file.
| AuthProvider | ||
| Constant | Defined by | ||
|---|---|---|---|
| AUTH_OPTIONS
[static] The constant that represents the additional authentication parameters required by the individual authentication provider.
| AuthProvider | ||
| AUTH_TYPE
[static] The constant that represents the type of authentication mechanism that should be used to process the given authentication parameters.
| AuthProvider | ||
| CERTIFICATE_PKCS7_SIGNATURE
[static] The constant that represents the signature property of the certificate authentication scheme of a User Management user account.
| AuthProvider | ||
| CERTIFICATE_UNSIGNED_DATA
[static] The constant that represents the unsigned data property of the certificate authentication scheme of a User Management user account.
| AuthProvider | ||
| CONTEXT
[static] The constant that represents a context property that authentication service providers should ignore.
| AuthProvider | ||
| ENCODED_KERBEROS_TICKET
[static] The constant that represents a Kerberos property that authentication service providers should ignore.
| AuthProvider | ||
| PASSWORD
[static] The constant that represents the password property of a User Management user account.
| AuthProvider | ||
| USER_NAME
[static] The constant that represents the user name property of a User Management user account.
| AuthProvider | ||
| authenticate | () |
public AuthResponse authenticate(Map credential, 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 AUTH_TYPE property is AuthScheme.AUTHTYPE_USERNAME_PWD. If no value is provided for AUTH_TYPE, AuthScheme.AUTHTYPE_USERNAME_PWD is used by default. |
|
authConfigs — A java.util.List object that contains the configuration information. |
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 AUTH_TYPE was not valid. |
See also
| getConfigName | () |
public 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.
ReturnsA java.lang.String containing the name of the parent node whose children are to be extracted. |
| AUTH_OPTIONS | Constant |
public static final AUTH_OPTIONSThe constant that represents the additional authentication parameters required by the individual authentication provider.
| AUTH_TYPE | Constant |
public static final AUTH_TYPEThe constant that represents the type of authentication mechanism that should be used to process the given authentication parameters.
| CERTIFICATE_PKCS7_SIGNATURE | Constant |
public static final CERTIFICATE_PKCS7_SIGNATUREThe constant that represents the signature property of the certificate authentication scheme of a User Management user account.
| CERTIFICATE_UNSIGNED_DATA | Constant |
public static final CERTIFICATE_UNSIGNED_DATAThe constant that represents the unsigned data property of the certificate authentication scheme of a User Management user account.
| CONTEXT | Constant |
public static final CONTEXTThe constant that represents a context property that authentication service providers should ignore.
The only valid value for this property is AuthScheme.AUTHTYPE_USERNAME_PWD.
| ENCODED_KERBEROS_TICKET | Constant |
public static final ENCODED_KERBEROS_TICKETThe constant that represents a Kerberos property that authentication service providers should ignore.
| PASSWORD | Constant |
public static final PASSWORDThe constant that represents the password property of a User Management user account.
| USER_NAME | Constant |
public static final USER_NAMEThe constant that represents the user name property of a User Management user account.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/um/spi/authentication/AuthProvider.html