|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
AuthResult authenticate(java.lang.String username, byte[] password) throws UMException
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.
username
- A string value that specifies the user name.password
- A byte array that specifies the user password.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.Context
AuthResult authenticate(java.lang.String username, byte[] password, java.util.List domainList) throws UMException
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.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.AuthResult authenticate(java.lang.String unsignedData, java.lang.String signatureValue) throws UMException
Context
instance.
unsignedData
- The unsigned data used in certificate-based authentication.signatureValue
- A base64-encoded, PKCS7-Detached digital signature.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.Context
AuthResult authenticate(java.lang.String unsignedData, java.lang.String signatureValue, java.util.List domainList) throws UMException
Context
instance.
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.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.Context
AuthResult authenticate(java.lang.String wssecHeader) throws UMException
wssecHeader
- A string value that specifies the WS-Security header.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.Context
AuthResult authenticate(java.lang.String wssecHeader, java.util.List domainList) throws UMException
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.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement) throws UMException
Context
instance.
wssecHeaderElement
- The WS-Security header element.
AuthResult
object that represents the authentication result.
UMException
- If the user was not authenticated.Context
AuthResult authenticate(org.w3c.dom.Element wssecHeaderElement, java.util.List domainList) throws UMException
Context
instance.
wssecHeaderElement
- The WS-Security header element.domainList
- A java.util.List
instance that represents a list of domains used to authenticate the user.
UMException
Context
AuthResult authenticate(byte[] ssoToken, boolean createAssertion) throws UMException
ssoToken
- A byte array that represents the SSO token.createAssertion
- A boolean value that specifies whether an assertion is created.
AuthResult
object that represents the authentication result.
IDException
IDPSystemException
UMException
SSOToken getSSOToken(Context context) throws UMException
context
- A Context
object that represents the context.
SSOToken
object that represents the SSO token.
UMException
byte[] getSSOTokenBytes(Context context) throws UMException
context
- The context.
UMException
java.util.List getAuthSchemes() throws UMException
List
of all the authentication schemes.
List
containing all the authentication schemes.
UMException
AuthResult getAuthResultOnBehalfOfUser(java.lang.String canonicalName, java.lang.String domainName, Context caller) throws UMException
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.
UMException
AuthResult validateAssertion(java.lang.String assertion) throws UMException
assertion
- The assertion.
UMException
Context validateAssertion(Context ctx) throws UMException
Context
after validating the assertion contained in the context. Returns the same context back if it is localOnly
ctx
- The context.
UMException
AuthResult authenticate(HttpRequestToken requestToken) throws UMException
HttpRequestToken
. Returns null
in case the token is
pointing to a stale session data.
requestToken
- token containing authentication related data
UMException
- with error code UMConstants.ErrorCodes.E_ASSERTION_ID_INVALID
if the assertionId is not validAuthResult renewAssertion(java.lang.String assertionId, Context context) throws UMException
UMConstants.FGACConstants.PERM_USER_MANAGER_RENEW_ASSERTION
permissionUMException
exception would be
thrown with error code UMConstants.ErrorCodes.E_ASSERTION_RENEWAL_COUNT_EXCEEDED
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
assertionId
- - The id of the assertion for the which renewal is requiredcontext
- - Context
of the user with specified permission as mentioned above.This context must
be a valid context.
AuthResult
containing the renewed assertion
UMException
- if the assertion is already expired or the renewal count has exceeded the specified limit
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |