com.adobe.livecycle.usermanager.client.AuthenticationManagerServiceClient (Livecycle)

	Method	Defined by
		AuthenticationManagerServiceClient(ServiceClientFactory serviceClientFactory) Authentication manager service client constructor.	AuthenticationManagerServiceClient
		AuthResult authenticate(String username, byte[] password) This is the primary method for authenticating a user.	AuthenticationManagerServiceClient
		AuthResult authenticate(byte[] ssoToken, boolean createAssertion) This is the primary method for authenticating a user from the single sign-on (SSO) servlet.	AuthenticationManagerServiceClient
		AuthResult authenticate(String wssecHeader) This method authenticates a WS-Security header in a SOAP request.	AuthenticationManagerServiceClient
		AuthResult authenticate(Element wssecHeaderElement) This method authenticates a WS-Security header element in a SOAP request.	AuthenticationManagerServiceClient
		AuthResult authenticate(String unsignedData, String signatureValue) This method is for certificate-based authentication.	AuthenticationManagerServiceClient
		AuthResult getAuthResultOnBehalfOfUser(String canonicalName, String domainName, Context caller) This method retrieves an authentication result on behalf of a user.	AuthenticationManagerServiceClient
		List getAuthSchemes() This method retrieves a `List` of all the authentication schemes.	AuthenticationManagerServiceClient
		SSOToken getSSOToken(Context context) Retrieves the single sign-on (SSO) token used in the SSO servlet.	AuthenticationManagerServiceClient
		byte[] getSSOTokenBytes(Context context) Retrieves a byte array representing the single sign-on (SSO) token used in the SSO servlet.	AuthenticationManagerServiceClient
		AuthResult validateAssertion(String assertion) This method creates and returns an authentication result after validating the assertion.	AuthenticationManagerServiceClient
		Context validateAssertion(Context ctx) This method creates and returns a com.adobe.idp.Context after validating the assertion contained in the context.	AuthenticationManagerServiceClient

Constructor Detail

AuthenticationManagerServiceClient

()

public AuthenticationManagerServiceClient(ServiceClientFactory serviceClientFactory)

Authentication manager service client constructor.

Parameters

serviceClientFactory — The service client factory.

Method Detail

authenticate

()

public AuthResult authenticate(String username, byte[] password)

This is the primary method for authenticating a user. It returns an authentication result indicating whether authentication was sucessful. That result can then be used in the com.adobe.idp.Context.

Parameters

	`username` — The user name.

	`password` — The password.

Returns

The authentication result.

Throws

UMException

See also

Context

authenticate

()

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

This is the primary method for authenticating a user from the single sign-on (SSO) servlet.

Parameters

	`ssoToken` — The SSO token.

	`createAssertion` — Used to determine whether an assertion is created.

Returns

The authentication result.

Throws

	`IDException`

	`IDPSystemException`

authenticate

()

public AuthResult authenticate(String wssecHeader)

This method authenticates a WS-Security header in a SOAP request. It returns an authentication result indicating whether authentication was sucessful. That result can then be used in the com.adobe.idp.Context.

Parameters

wssecHeader — The WS-Security header.

Returns

The authentication result.

Throws

UMException

See also

Context

authenticate

()

public AuthResult authenticate(Element wssecHeaderElement)

This method authenticates a WS-Security header element in a SOAP request. It returns an authentication result indicating whether authentication was sucessful. That result can then be used in the com.adobe.idp.Context.

Parameters

wssecHeaderElement — The WS-Security header element.

Returns

The authentication result.

Throws

UMException

See also

Context

authenticate

()

public AuthResult authenticate(String unsignedData, String signatureValue)

This method is for certificate-based authentication. It returns an authentication result indicating whether authentication was sucessful. That result can then be used in the com.adobe.idp.Context.

Parameters

	`unsignedData` — The unsigned data used in certificate-based authentication.

	`signatureValue` — A base64-encoded, PKCS7-Detached digital signature.

Returns

The authentication result.

Throws

UMException

See also

Context

getAuthResultOnBehalfOfUser

()

public AuthResult getAuthResultOnBehalfOfUser(String canonicalName, String domainName, Context caller)

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

getAuthSchemes

()

public List getAuthSchemes()

This method retrieves a List of all the authentication schemes.

Returns

A List containing all the authentication schemes.

Throws

UMException

getSSOToken

()

public SSOToken getSSOToken(Context context)

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

Parameters

context — The context.

Returns

The SSO token.

Throws

UMException

getSSOTokenBytes

()

public byte[] getSSOTokenBytes(Context context)

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

validateAssertion

()

public AuthResult validateAssertion(String assertion)

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

Parameters

assertion — The assertion.

Returns

The authentication result.

Throws

UMException

validateAssertion

()

public Context validateAssertion(Context ctx)

This method creates and returns a com.adobe.idp.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

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/livecycle/usermanager/client/AuthenticationManagerServiceClient.html

LiveCycle ES Java API Reference	All Packages \| All Classes \| Index \| Frames No Frames
Class AuthenticationManagerServiceClient	Methods

Package	com.adobe.livecycle.usermanager.client
Class	public class AuthenticationManagerServiceClient
Inheritance	AuthenticationManagerServiceClient ManagerServiceClient