Packagecom.adobe.idp.um.api
Interfacepublic interface AuthenticationManager

This is the primary interface for authenticating users.


Public Methods
 MethodDefined By
  
AuthResult authenticate(String username, byte[] password)
This is the primary method for authenticating a user.
AuthenticationManager
  
AuthResult authenticate(String username, byte[] password, List domainList)
This is the primary method for authenticating a user.
AuthenticationManager
  
AuthResult authenticate(String unsignedData, String signatureValue)
This method is for certificate-based authentication.
AuthenticationManager
  
AuthResult authenticate(String unsignedData, String signatureValue, List domainList)
This method is for certificate-based authentication.
AuthenticationManager
  
AuthResult authenticate(String wssecHeader)
This method authenticates a WS-Security header in a SOAP request.
AuthenticationManager
  
AuthResult authenticate(String wssecHeader, List domainList)
This method authenticates a WS-Security header in a SOAP request.
AuthenticationManager
  
AuthResult authenticate(Element wssecHeaderElement)
This method authenticates a WS-Security header element in a SOAP request.
AuthenticationManager
  
AuthResult authenticate(Element wssecHeaderElement, List domainList)
This method authenticates a WS-Security header element in a SOAP request.
AuthenticationManager
  
AuthResult authenticate(byte[] ssoToken, boolean createAssertion)
This is the primary method for authenticating a user from the single sign-on (SSO) servlet.
AuthenticationManager
  
AuthResult getAuthResultOnBehalfOfUser(String canonicalName, String domainName, Context caller)
This method retrieves an authentication result on behalf of a user.
AuthenticationManager
  
List getAuthSchemes()
This method retrieves a List of all the authentication schemes.
AuthenticationManager
  
SSOToken getSSOToken(Context context)
Retrieves the single sign-on (SSO) token used in the SSO servlet.
AuthenticationManager
  
byte[] getSSOTokenBytes(Context context)
Retrieves a byte array representing the single sign-on (SSO) token used in the SSO servlet.
AuthenticationManager
  
AuthResult renewAssertion(String assertionId, Context context)
Renews the SAML assertion referred by the given assertionId.
AuthenticationManager
  
AuthResult validateAssertion(String assertion)
This method creates and returns an authentication result after validating the assertion.
AuthenticationManager
  
Context validateAssertion(Context ctx)
This method creates and returns a com.adobe.idp.Context after validating the assertion contained in the context.
AuthenticationManager
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(String username, byte[] password, List domainList)

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.
 
domainList — List of domains against which user should be authenticated

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
authenticate() 
public AuthResult authenticate(String unsignedData, String signatureValue, List domainList)

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.
 
domainList — List of domains against which user should be authenticated

Returns
The authentication result.

Throws
UMException

See also

Context
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(String wssecHeader, List domainList)

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.
 
domainList — List of domains against which user should be authenticated

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(Element wssecHeaderElement, List domainList)

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.
 
domainList — List of domains against which user should be authenticated

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
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
renewAssertion() 
public AuthResult renewAssertion(String assertionId, Context context)

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



© 2004-2008 Adobe Systems Incorporated. All rights reserved.
Wed Oct 1 2008, 10:46 PM -04:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/javadoc/com/adobe/idp/um/api/AuthenticationManager.html