| Package | com.adobe.idp |
| Class | public final class Context |
| Inheritance | Context  Object
|
Propagates crucial information among IDP components, and is used in many of the product APIs. By convention, it appears as the last parameter in any method that propagates it.
Currently, the context propagates:
The context is designed so that it can be serialized to an older version of itself and back without losing any information.
| Method | Defined by | ||
|---|---|---|---|
|
Context()
Default constructor.
| Context | ||
|
[static] Instantiates a context from a byte array.
| Context | ||
|
Retrieves the authenticated user.
| Context | ||
|
Date getExpirationHint()
Provides a date indicating when this
Context will expire. | Context | ||
|
String getRequestId()
Retrieves the request ID.
| Context | ||
|
String getUserAssertion()
Retrieves the user's assertion string.
| Context | ||
|
void initPrincipal(AuthResult authResult)
Initializes the
Context object's Principal (the authenticated user). | Context | ||
|
void initRequestId(String requestId)
Initializes the request ID.
| Context | ||
|
boolean isComplete()
| Context | ||
|
byte[] toByteArray()
Converts a context to a byte array.
| Context | ||
|
String toString()
Retrieves a printable rendition of the context.
| Context | ||
| Context | () |
public Context()Default constructor.
| create | () |
public static Context create(byte[] buf)Instantiates a context from a byte array. This can be useful when using IDL-defined CORBA interfaces.
Parameters
buf — The byte array used to create the context. |
| The context. |
| getAuthenticatedUser | () |
| getExpirationHint | () |
public Date getExpirationHint()Provides a date indicating when this Context will expire. There is no guarantee that the value is accurate, but it will be no later than the actual expiration date.
| The latest possible expiration date. |
| getRequestId | () |
public String getRequestId()Retrieves the request ID.
Returns| The request ID. |
| getUserAssertion | () |
public String getUserAssertion()Retrieves the user's assertion string.
Returns| The user's assertion string. |
| initPrincipal | () |
public void initPrincipal(AuthResult authResult)Initializes the Context object's Principal (the authenticated user).
Parameters
authResult — The information used to set the authenticated user's information. |
| initRequestId | () |
public void initRequestId(String requestId)Initializes the request ID.
Parameters
requestId — The request ID to be initialized. |
| isComplete | () |
public boolean isComplete()
Returns
| toByteArray | () |
public byte[] toByteArray()Converts a context to a byte array. This can be useful when using IDL-defined CORBA interfaces.
Returns| A byte array containing the context information. |
| toString | () |
public String toString()Retrieves a printable rendition of the context.
Returns
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/Context.html