com.adobe.livecycle.usermanager.client
Class AuthenticationManagerServiceClient

java.lang.Object
  ManagerServiceClient
      com.adobe.livecycle.usermanager.client.AuthenticationManagerServiceClient

All Implemented Interfaces:

AuthenticationManager

public class AuthenticationManagerServiceClient
extends ManagerServiceClient
implements AuthenticationManager

This is the client implementation of the AuthenticationManager class.

See Also:

AuthenticationManager

Constructor Summary

AuthenticationManagerServiceClient(ServiceClientFactory serviceClientFactory)
Authentication manager service client constructor.

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(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 unsignedData, java.lang.String signatureValue) 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.
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.idp.um.api.AuthenticationManager

authenticate, authenticate, authenticate, authenticate, renewAssertion

Constructor Detail

AuthenticationManagerServiceClient

public AuthenticationManagerServiceClient(ServiceClientFactory serviceClientFactory)

Authentication manager service client constructor.

Parameters:

serviceClientFactory - The service client factory.

Method Detail

authenticate

public 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.

Specified by:

authenticate in interface AuthenticationManager

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

public AuthResult authenticate(byte[] ssoToken,
                               boolean createAssertion)
                        throws UMException

Authenticates a LiveCycle user using a single sign-on (SSO) servlet.

Specified by:

authenticate in interface AuthenticationManager

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:

UMException

authenticate

public 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.

Specified by:

authenticate in interface AuthenticationManager

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

getAuthResultOnBehalfOfUser

public 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.

Specified by:

getAuthResultOnBehalfOfUser in interface AuthenticationManager

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

getSSOToken

public SSOToken getSSOToken(Context context)
                     throws UMException

Retrieves the single sign-on (SSO) token used in the SSO servlet.

Specified by:

getSSOToken in interface AuthenticationManager

Parameters:

context - A Context object that represents the context.

Returns:

A SSOToken object that represents the SSO token.

Throws:

UMException

getSSOTokenBytes

public byte[] getSSOTokenBytes(Context context)
                        throws UMException

Retrieves a byte array representing the single sign-on (SSO) token used in the SSO servlet.

Specified by:

getSSOTokenBytes in interface AuthenticationManager

Parameters:

context - The context.

Returns:

A byte array containing the SSO token information.

Throws:

UMException

authenticate

public 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.

Specified by:

authenticate in interface AuthenticationManager

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

public 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.

Specified by:

authenticate in interface AuthenticationManager

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

getAuthSchemes

public java.util.List getAuthSchemes()
                              throws UMException

This method retrieves a List of all the authentication schemes.

Specified by:

getAuthSchemes in interface AuthenticationManager

Returns:

A List containing all the authentication schemes.

Throws:

UMException

validateAssertion

public AuthResult validateAssertion(java.lang.String assertion)
                             throws UMException

This method creates and returns an authentication result after validating the assertion.

Specified by:

validateAssertion in interface AuthenticationManager

Parameters:

assertion - The assertion.

Returns:

The authentication result.

Throws:

UMException

validateAssertion

public 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

Specified by:

validateAssertion in interface AuthenticationManager

Parameters:

ctx - The context.

Returns:

The validated context.

Throws:

UMException