|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.idp.Context
public final class Context
This class represents an authenticated LiveCycle ES2 user or group.
You can use a com.adobe.idp.Context
object to invoke a LiveCycle ES2 service using an authenticated user
(the com.adobe.idp.Context
object represents an authenticated user).
When using a com.adobe.idp.Context
object, you do not need to set the DSC_CREDENTIAL_USERNAME
or DSC_CREDENTIAL_PASSWORD
connection settings.
You can obtain a com.adobe.idp.Context
object when authenicating users by using the AuthenticationManagerServiceClient
object’s authenticate
method.
For information about using this object to authenticate a user and invoking a LiveCycle ES2 service, see the
Authenticating Users topic in Programming with LiveCycle ES4.
Constructor Summary | |
---|---|
Context()
Default constructor. |
Method Summary | |
---|---|
static Context |
create(byte[] buf)
Instantiates a context from a byte array. |
User |
getAuthenticatedUser()
Retrieves the authenticated user. |
java.util.Date |
getExpirationHint()
Provides a date indicating when this Context will expire. |
java.lang.String |
getRequestId()
Retrieves the request identifier value. |
java.lang.String |
getUserAssertion()
Retrieves the user's assertion string. |
void |
initPrincipal(AuthResult authResult)
Initializes the Context object's Principal (the authenticated user). |
void |
initRequestId(java.lang.String requestId)
Initializes the request identifier value. |
boolean |
isComplete()
Determines if the context is complete |
byte[] |
toByteArray()
Converts a context to a byte array. |
java.lang.String |
toString()
Retrieves a printable rendition of the context. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Context()
Method Detail |
---|
public static Context create(byte[] buf)
buf
- The byte array used to create the context.
public byte[] toByteArray()
public void initPrincipal(AuthResult authResult)
Context
object's Principal
(the authenticated user).
This method is called to set the authenticated user in the Context
object.
The only way to get an AuthResult
is by invoking the authenticate
method in the
AuthenticationManagerServiceClient
class.
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.
authResult
- An AuthResult
object that represents the authenticated user.public boolean isComplete()
public User getAuthenticatedUser()
User
object that represents the authenticated user.public java.util.Date getExpirationHint()
Context
will expire. There is no guarantee
that the value is accurate, but it will be no later than the actual expiration date.
public java.lang.String getUserAssertion()
public void initRequestId(java.lang.String requestId)
requestId
- The request ID to be initialized.public java.lang.String getRequestId()
public java.lang.String toString()
toString
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |