public final class UserActivityInfo extends Object
Modifier and Type | Class and Description |
---|---|
static class |
UserActivityInfo.ErrorInfo
Represents an error object for an error that caused the request to fail.
|
static class |
UserActivityInfo.EventInfo
Represents a primary event that triggered the request.
|
Modifier and Type | Field and Description |
---|---|
static String |
CURR_KEY
* Used to locate the UserActivityInfo for the curent request.
|
static String |
PREV_KEY
Used to locate the UserActivityInfo for the previous request.
|
static String |
USER_ACTIVITY_INFO_REQ_PARAM
Used to store the user activity information in the requestMap
|
Constructor and Description |
---|
UserActivityInfo(String contextId, String parentContextId, String clientStartTime, String clientEndTime)
Creates a user activity record for the request identified by the provided contextId.
|
UserActivityInfo(String viewId, String windowId, UserActivityInfo.EventInfo eventInfo, String clientStartTime, List<UserActivityInfo.ErrorInfo> errors, List<String> partialTargets)
Creates a user activity record for the current context.
|
Modifier and Type | Method and Description |
---|---|
String |
getClientEndTime()
Gets the client end time.
|
String |
getClientStartTime()
Gets the client start time.
|
String |
getContextId()
Gets the context identifier.
|
List<UserActivityInfo.ErrorInfo> |
getErrors()
A list of ErrorInfo objects, representing the errors that caused the request to fail.
|
UserActivityInfo.EventInfo |
getEventInfo()
Gets the EventInfo object that contains the event info of the event that triggered this request.
|
String |
getParentContextId()
Gets the parent's context identifier.
|
String |
getParentResponseReceivedTime()
Gets the time the client browser received a response for the PPR request identified by getParentContextId().
|
List<String> |
getPartialTargets()
A list of client component ids of components that are registered as partial targets for the request.
|
static String |
getPreviousKeyInSequence(int sequence)
Gets the previous key to use for the specified sequence number.
|
String |
getRedirectLocation()
Gets the location current request is being redirected to.
|
String |
getRedirectStatusCode()
Gets the status code returned in the PPR response (header) when the current request is being redirected to the redirect location.
|
String |
getResponseReceivedTime()
Gets the time the client browser received the response for a PPR request identified by the contextId returned by getContextId().
|
String |
getViewId()
The viewId for the request.
|
String |
getWindowId()
The windowId of the window that initiated the request.
|
void |
setErrors(List<UserActivityInfo.ErrorInfo> errors)
Sets a list of ErrorInfo objects on the UserActivityInfo instance pertaining to the current request.
|
void |
setEventInfo(UserActivityInfo.EventInfo eventInfo)
Sets the event information (typically) on the UserActivityInfo instance pertaining to the current request.
|
void |
setParentResponseReceivedTime(String time)
Sets the time response was received by the browser client for a parent PPR request.
|
void |
setPartialTargets(List<String> partialTargets)
Sets the list of partial targets on the UserActivityInfo instance pertaining to the current request.
|
void |
setRedirectInfo(String location, String statusCode)
For PPR Redirects when the client is about to be redirected to a different URL this method is called to set the location and status code.
|
void |
setResponseReceivedTime(String time)
Sets the time response was received by the browser client for a PPR request.
|
void |
setViewId(String viewId)
Sets the viewId on the UserActivityInfo instance pertaining to the current request.
|
void |
setWindowId(String windowId)
Sets the windowId on the UserActivityInfo instance pertaining to the current request.
|
String |
toString() |
public static final String USER_ACTIVITY_INFO_REQ_PARAM
public static final String PREV_KEY
public static final String CURR_KEY
public UserActivityInfo(String contextId, String parentContextId, String clientStartTime, String clientEndTime)
contextId
- the String context identifier for a primary request or a secondary request. This is a required parameter and a warnign is logged if null.parentContextId
- the String identifier of the ExecutionContext associated with the parent request. This is typically passed in for child (secondary) requests of a primary. This can be null when called for a primary request.clientStartTime
- start time of the client request in UTC using the client's clock. For the page 0 request, client start time will be the "approximate start time", iow, the start time is clocked when the page is about to load on the client rather than the start time when the initial page 0 request was received on the server. This is a required parameter and a warning is logged if null.clientEndTime
- the end time of the user action. Can be null for the current request as it's currently being serviced.public UserActivityInfo(String viewId, String windowId, UserActivityInfo.EventInfo eventInfo, String clientStartTime, List<UserActivityInfo.ErrorInfo> errors, List<String> partialTargets)
viewId
- the current viewId, this cannot be null.windowId
- the current windowId ((to distinguish results from multiple windows in the same session). This can not be null.eventInfo
- information pertaining to the primary event that caused this server request. If an attribute change caused this request, we may not have an event. But we will certainly have a pprTargets. This can be null in cases where attribute changes caused a partial request.clientStartTime
- start time of the client request in UTC using the client's clock. Usually cannot be null but for the page 0 request, client start time will be null. Also due to the page-0 problem start time will have approximate value.errors
- errors captured on the client, for the current request. If there were no errors this would be null. Server errors get logged as and when they occur.partialTargets
- a list of component ids that have registered as partial targets (on the client) for the current request. If there are no partial targets, this will be null.public String getContextId()
public String getParentContextId()
getContextId()
).public String getRedirectLocation()
public String getRedirectStatusCode()
public String getClientStartTime()
public String getClientEndTime()
public UserActivityInfo.EventInfo getEventInfo()
public List<UserActivityInfo.ErrorInfo> getErrors()
public static String getPreviousKeyInSequence(int sequence)
sequence
- the int ffor which to generate the keypublic String getResponseReceivedTime()
public String getParentResponseReceivedTime()
public String getViewId()
public String getWindowId()
public List<String> getPartialTargets()
public void setEventInfo(UserActivityInfo.EventInfo eventInfo)
eventInfo
- an EventInfo objectpublic void setRedirectInfo(String location, String statusCode)
location
- url to be redirected to.statusCode
- HTTP status code sent to the client.public void setErrors(List<UserActivityInfo.ErrorInfo> errors)
errors
- List of ErrorInfo objectspublic void setPartialTargets(List<String> partialTargets)
partialTargets
- a List of partial targets.public void setResponseReceivedTime(String time)
time
- time response was received by the browser.public void setParentResponseReceivedTime(String time)
time
- time response was received by the browser.public void setViewId(String viewId)
viewId
- the viewId.public void setWindowId(String windowId)
windowId
- the windowId for the current window.