com.adobe.idp.um.api
Interface AuthenticationManager

All Known Implementing Classes:
AuthenticationManagerServiceClient

public interface AuthenticationManager

The AuthenticationManager interface is the primary interface for authenticating LiveCycle users. Using an object of this type, you can authenticate LiveCycle users. For information, see the Authenticating Users section in Programming with LiveCycle ES4.

To see an object of this type used in a code example, see the Authenticating a user using the Java API quick start in Programming with LvieCycle ES4.


Method Summary
 AuthResult authenticate(byte[] ssoToken, boolean createAssertion)
          Authenticates a LiveCycle user using a single sign-on (SSO) servlet.
 AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement)
          Authenticates a LiveCycle user using a WS-Security header element in a SOAP request.
 AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement, java.util.List domainList)
          Authenticates a LiveCycle user using a WS-Security header element in a SOAP request.
 AuthResult authenticate(HttpRequestToken requestToken)
          Authenticates using the given HttpRequestToken.
 AuthResult authenticate(java.lang.String wssecHeader)
          Authenticates a LiveCycle user using a WS-Security header in a SOAP request.
 AuthResult authenticate(java.lang.String username, byte[] password)
          Authenticates a LiveCycle user.
 AuthResult authenticate(java.lang.String username, byte[] password, java.util.List domainList)
          Authenticates a LiveCycle user.
 AuthResult authenticate(java.lang.String wssecHeader, java.util.List domainList)
          Authenticates a LiveCycle user using a WS-Security header in a SOAP request.
 AuthResult authenticate(java.lang.String unsignedData, java.lang.String signatureValue)
          Authenticates a LiveCycle user using certificate-based authentication.
 AuthResult authenticate(java.lang.String unsignedData, java.lang.String signatureValue, java.util.List domainList)
          Authenticates a LiveCycle user using certificate-based authentication.
 AuthResult getAuthResultOnBehalfOfUser(java.lang.String canonicalName, java.lang.String domainName, Context caller)
          This method retrieves an authentication result on behalf of a user.
 java.util.List getAuthSchemes()
          This method retrieves a List of all the authentication schemes.
 SSOToken getSSOToken(Context context)
          Retrieves the single sign-on (SSO) token used in the SSO servlet.
 byte[] getSSOTokenBytes(Context context)
          Retrieves a byte array representing the single sign-on (SSO) token used in the SSO servlet.
 AuthResult renewAssertion(java.lang.String assertionId, Context context)
          Renews the SAML assertion referred by the given assertionId.
 Context validateAssertion(Context ctx)
          This method creates and returns a Context after validating the assertion contained in the context.
 AuthResult validateAssertion(java.lang.String assertion)
          This method creates and returns an authentication result after validating the assertion.
 

Method Detail

authenticate

AuthResult authenticate(java.lang.String username,
                        byte[] password)
                        throws UMException
Authenticates a LiveCycle user. This method returns an authentication result indicating whether authentication was sucessful. The authentication result can be used in the Context instance.

To see this method used in a code example, see the Authenticating a user using the Java API quick start in Programming with LiveCycle ES4.

Parameters:
username - A string value that specifies the user name.
password - A byte array that specifies the user password.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.
See Also:
Context

authenticate

AuthResult authenticate(java.lang.String username,
                        byte[] password,
                        java.util.List domainList)
                        throws UMException
Authenticates a LiveCycle user. This method returns an authentication result indicating whether authentication was sucessful.

Parameters:
username - A string value that specifies the user name.
password - A byte array that specifies the user password.
domainList - List of domains against which the user is authenticated.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.

authenticate

AuthResult authenticate(java.lang.String unsignedData,
                        java.lang.String signatureValue)
                        throws UMException
Authenticates a LiveCycle user using certificate-based authentication. This method returns an authentication result indicating whether authentication was sucessful. The authentication result can be used in the Context instance.

Parameters:
unsignedData - The unsigned data used in certificate-based authentication.
signatureValue - A base64-encoded, PKCS7-Detached digital signature.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.
See Also:
Context

authenticate

AuthResult authenticate(java.lang.String unsignedData,
                        java.lang.String signatureValue,
                        java.util.List domainList)
                        throws UMException
Authenticates a LiveCycle user using certificate-based authentication. This method returns an authentication result indicating whether authentication was sucessful. The authentication result can be used in the Context instance.

Parameters:
unsignedData - The unsigned data used in certificate-based authentication.
signatureValue - A base64-encoded, PKCS7-Detached digital signature.
domainList - A java.util.List instance that represents a list of domains used to authenticate the user.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.
See Also:
Context

authenticate

AuthResult authenticate(java.lang.String wssecHeader)
                        throws UMException
Authenticates a LiveCycle user using a WS-Security header in a SOAP request. This mehtod returns an authentication result indicating whether authentication was sucessful.

Parameters:
wssecHeader - A string value that specifies the WS-Security header.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.
See Also:
Context

authenticate

AuthResult authenticate(java.lang.String wssecHeader,
                        java.util.List domainList)
                        throws UMException
Authenticates a LiveCycle user using a WS-Security header in a SOAP request. This method returns an authentication result indicating whether the authentication was sucessful.

Parameters:
wssecHeader - A string value that specifies the WS-Security header.
domainList - A java.util.List instance that represents a list of domains used to authenticate the user.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.

authenticate

AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement)
                        throws UMException
Authenticates a LiveCycle user using a WS-Security header element in a SOAP request. This method returns an authentication result indicating whether authentication was sucessful. The authentication result can be used in the Context instance.

Parameters:
wssecHeaderElement - The WS-Security header element.
Returns:
An AuthResult object that represents the authentication result.
Throws:
UMException - If the user was not authenticated.
See Also:
Context

authenticate

AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement,
                        java.util.List domainList)
                        throws UMException
Authenticates a LiveCycle user using a WS-Security header element in a SOAP request. It returns an authentication result indicating whether authentication was sucessful. The authentication result can be used in the Context instance.

Parameters:
wssecHeaderElement - The WS-Security header element.
domainList - A java.util.List instance that represents a list of domains used to authenticate the user.
Returns:
The authentication result.
Throws:
UMException
See Also:
Context

authenticate

AuthResult authenticate(byte[] ssoToken,
                        boolean createAssertion)
                        throws UMException
Authenticates a LiveCycle user using a single sign-on (SSO) servlet.

Parameters:
ssoToken - A byte array that represents the SSO token.
createAssertion - A boolean value that specifies whether an assertion is created.
Returns:
An AuthResult object that represents the authentication result.
Throws:
IDException
IDPSystemException
UMException

getSSOToken

SSOToken getSSOToken(Context context)
                     throws UMException
Retrieves the single sign-on (SSO) token used in the SSO servlet.

Parameters:
context - A Context object that represents the context.
Returns:
A SSOToken object that represents the SSO token.
Throws:
UMException

getSSOTokenBytes

byte[] getSSOTokenBytes(Context context)
                        throws UMException
Retrieves a byte array representing the single sign-on (SSO) token used in the SSO servlet.

Parameters:
context - The context.
Returns:
A byte array containing the SSO token information.
Throws:
UMException

getAuthSchemes

java.util.List getAuthSchemes()
                              throws UMException
This method retrieves a List of all the authentication schemes.

Returns:
A List containing all the authentication schemes.
Throws:
UMException

getAuthResultOnBehalfOfUser

AuthResult getAuthResultOnBehalfOfUser(java.lang.String canonicalName,
                                       java.lang.String domainName,
                                       Context caller)
                                       throws UMException
This method retrieves an authentication result on behalf of a user. This method can be used to impersonate a user (typically a system user) who has higher privilege.

Parameters:
canonicalName - The canonical name of the user.
domainName - The domain name to which the user belongs. This parameter is case sensitive. For example, the domain names "adobe" and "Adobe" would be treated differently.
caller - The context of the caller.
Returns:
The authentication result.
Throws:
UMException

validateAssertion

AuthResult validateAssertion(java.lang.String assertion)
                             throws UMException
This method creates and returns an authentication result after validating the assertion.

Parameters:
assertion - The assertion.
Returns:
The authentication result.
Throws:
UMException

validateAssertion

Context validateAssertion(Context ctx)
                          throws UMException
This method creates and returns a Context after validating the assertion contained in the context. Returns the same context back if it is localOnly

Parameters:
ctx - The context.
Returns:
The validated context.
Throws:
UMException

authenticate

AuthResult authenticate(HttpRequestToken requestToken)
                        throws UMException
Authenticates using the given HttpRequestToken. Returns null in case the token is pointing to a stale session data.

Parameters:
requestToken - token containing authentication related data
Returns:
AuthResult if authentication is successful. In case the http token contains reference to a sso session which has expired then an UMException would be thrown
Throws:
UMException - with error code UMConstants.ErrorCodes.E_ASSERTION_ID_INVALID if the assertionId is not valid

renewAssertion

AuthResult renewAssertion(java.lang.String assertionId,
                          Context context)
                          throws UMException
Renews the SAML assertion referred by the given assertionId. The assertion would be renewed only if following conditions are met The assertionId is the value of the cookie set by the UM during the authentication process. The cookie name is specified by UMConstants.SSOConstants.LIVECYCLE_AUTH_TOKEN. The value can also be obtained using HttpRequestToken. For example String assertionId = new HttpRequestToken(servletRequest).getAssertionId(); Here the servletRequest is an object of type HttpServletRequest

Parameters:
assertionId - - The id of the assertion for the which renewal is required
context - - Context of the user with specified permission as mentioned above.This context must be a valid context.
Returns:
an AuthResult containing the renewed assertion
Throws:
UMException - if the assertion is already expired or the renewal count has exceeded the specified limit


[an error occurred while processing this directive] [an error occurred while processing this directive]