com.adobe.idp.um.api
Class UMConstants.AuthenticationOptions

java.lang.Object
  extended by com.adobe.idp.um.api.UMConstants.AuthenticationOptions
Enclosing class:
UMConstants

public static final class UMConstants.AuthenticationOptions
extends java.lang.Object

This class contains constants related to authentication options. Also some of these are used in the AuthProvider.authenticate(} method


Field Summary
static java.lang.String ATTR_RESPONSE_WRITTEN
          An AuthProvider should set this value to Boolean.TRUE if it has modified the response.
static java.lang.String AUDIT_ENABLED
          Constant that holds the name of the property specifying if this authentication request should be Audited or not.
static java.lang.String AUTH_PROVIDER_RETURN_TOKENS
          Constant key that holds the Map of tokens returned by an AuthProvider in credentials Map.
static java.lang.String AUTH_TOKEN_TYPES
          Constant that holds the name of the property specifying Authentication token types to be used for this authentication request.
static java.lang.String AUTHENTICATED_USER_KEY
          Constant key that holds the Authenticated User returned from AuthProvider or IdentityCreator
static java.lang.String CLIENT_IP_ADDRESS
          Constant that holds the name of the property specifying Client's IP address for Auditing purposes.
static java.lang.String DOMAIN_LIST
          Constant that holds the list of domain names against which the authentication had to be made
static java.lang.String DOMAIN_NAME
          Constant that holds the domain name against which the authentication had to be made
static java.lang.String FULL_PRINCIPAL_OBJECT
          Constant that holds the name of the property specifying if the returned AuthResult contains Fully exploded User object or not.
static java.lang.String SESSION_TIMEOUT
          Constant that holds the name of the property specifying the value of session timeout to be used for this authentication request.
static java.lang.String THIRD_PARTY_SAML_ASSERTION
          Constant key that hold the SAML assertion XML.
static java.lang.String USER_CERTIFICATE
          Constant key that hold a list of X509Certificates.
static java.lang.String WS_SEC_HEADER
          Constant that holds the WS-Security header if the authentication is being called for a Web Service Request
 
Constructor Summary
UMConstants.AuthenticationOptions()
           
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DOMAIN_NAME

public static final java.lang.String DOMAIN_NAME
Constant that holds the domain name against which the authentication had to be made

See Also:
Constant Field Values

DOMAIN_LIST

public static final java.lang.String DOMAIN_LIST
Constant that holds the list of domain names against which the authentication had to be made

See Also:
Constant Field Values

CLIENT_IP_ADDRESS

public static final java.lang.String CLIENT_IP_ADDRESS
Constant that holds the name of the property specifying Client's IP address for Auditing purposes. This property can be set in authenticationOptions passed while authenticating via any of authenticate methods in UserManagerUtilServiceClient

See Also:
Constant Field Values

FULL_PRINCIPAL_OBJECT

public static final java.lang.String FULL_PRINCIPAL_OBJECT
Constant that holds the name of the property specifying if the returned AuthResult contains Fully exploded User object or not. This property can be set in authenticationOptions passed while authenticating via any of authenticate methods in UserManagerUtilServiceClient

See Also:
Constant Field Values

AUDIT_ENABLED

public static final java.lang.String AUDIT_ENABLED
Constant that holds the name of the property specifying if this authentication request should be Audited or not. This property can be set in authenticationOptions passed while authenticating via any of authenticate methods in UserManagerUtilServiceClient

See Also:
Constant Field Values

AUTH_TOKEN_TYPES

public static final java.lang.String AUTH_TOKEN_TYPES
Constant that holds the name of the property specifying Authentication token types to be used for this authentication request. The value of this property will have a list containing suth token types. This property can be set in authenticationOptions passed while authenticating via any of authenticate methods in UserManagerUtilServiceClient

See Also:
Constant Field Values

SESSION_TIMEOUT

public static final java.lang.String SESSION_TIMEOUT
Constant that holds the name of the property specifying the value of session timeout to be used for this authentication request. The value of this property will have an integer conataining session timeout value in minutes.. This property can be set in authenticationOptions passed while authenticating via any of authenticate methods in UserManagerUtilServiceClient

See Also:
Constant Field Values

WS_SEC_HEADER

public static final java.lang.String WS_SEC_HEADER
Constant that holds the WS-Security header if the authentication is being called for a Web Service Request

See Also:
Constant Field Values

ATTR_RESPONSE_WRITTEN

public static final java.lang.String ATTR_RESPONSE_WRITTEN
An AuthProvider should set this value to Boolean.TRUE if it has modified the response. If this is set to true then authentication logic would not process the request further.

See Also:
Constant Field Values

THIRD_PARTY_SAML_ASSERTION

public static final java.lang.String THIRD_PARTY_SAML_ASSERTION
Constant key that hold the SAML assertion XML. This would be used while invoking the IdentityResolver

See Also:
Constant Field Values

USER_CERTIFICATE

public static final java.lang.String USER_CERTIFICATE
Constant key that hold a list of X509Certificates. The first certificate would be of the user and other are those which make up the trust chain

See Also:
Constant Field Values

AUTH_PROVIDER_RETURN_TOKENS

public static final java.lang.String AUTH_PROVIDER_RETURN_TOKENS
Constant key that holds the Map of tokens returned by an AuthProvider in credentials Map.


AUTHENTICATED_USER_KEY

public static final java.lang.String AUTHENTICATED_USER_KEY
Constant key that holds the Authenticated User returned from AuthProvider or IdentityCreator

Constructor Detail

UMConstants.AuthenticationOptions

public UMConstants.AuthenticationOptions()