|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectariba.ui.aribaweb.util.AWBaseObject
ariba.ui.aribaweb.core.AWRequestContext
public class AWRequestContext
The context tracking state through all phases of a single request/response cycle.
The RequestContext encapsulates the incoming AWRequest
and the outgoing
AWResponse
. As the primary argument in the methods
it tracks the evolving ElementId as the document structure unfolds, providing Ids
through nextElementId()
, pushElementIdLevel()
, and @popElementIdLevel
.
Nested Class Summary | |
---|---|
static interface |
AWRequestContext._SubcomponentLookup
|
static class |
AWRequestContext.RetryRequestException
|
Field Summary | |
---|---|
static java.lang.String |
FrameNameKey
|
static java.lang.String |
IgnoreRefreshCompleteKey
|
static java.lang.String |
IncrementalUpdateKey
|
static java.lang.String |
InPageAction
|
static java.lang.String |
InPageRequest
|
static java.lang.String |
PageScrollLeftKey
|
static java.lang.String |
PageScrollTopKey
|
static int |
Phase_ApplyValues
|
static int |
Phase_InvokeAction
|
static int |
Phase_Render
|
static java.lang.String |
RecordingModeKey
|
static java.lang.String |
RefreshRequestKey
|
static ThreadDebugKey |
RequestContextID
|
static java.lang.String |
ResponseIdKey
|
static AWEncodedString |
SelfFrameName
|
static java.lang.String |
SessionIdKey
|
static java.lang.String |
SessionRendevousKey
|
static java.lang.String |
SessionSecureIdKey
|
static java.lang.String |
SessionSecureIdKeyEquals
|
static AWEncodedString |
TopFrameName
|
static boolean |
UseXmlHttpRequests
|
Fields inherited from class ariba.ui.aribaweb.util.AWBaseObject |
---|
AribaHashtableClass, AribaVectorClass, ClassClass, EmptyHashtable, EmptyMap, EmptyVector, False, IntegerClass, JavaHashtableClass, JavaMapClass, JavaVectorClass, LogHandling, NullObject, ObjectClass, StringClass, True, UndefinedObject, UndefinedString, UninitializedRealNumber |
Constructor Summary | |
---|---|
AWRequestContext()
|
Method Summary | |
---|---|
boolean |
_debugIsInPlaybackMode()
|
boolean |
_debugIsInRecordingMode()
|
void |
_debugPopSemanticKeyPrefix()
|
void |
_debugPushSemanticKeyPrefix()
|
AWEncodedString |
_debugResponseIdAsIs()
|
java.lang.String |
_debugSemanticKeyPrefix()
|
void |
_debugSetSemanticKeyPrefix(java.lang.String prefix)
|
boolean |
_debugShouldRecord()
|
void |
_debugSkipRecordPlayback()
|
AWElementIdGenerator |
_getElementIdGenerator()
|
void |
_overrideRequest(AWRequest newRequest)
|
static AWRequestContext |
_requestContext()
Return the request context if there is one is associated with the current thread and null otherwise |
void |
addCookie(AWCookie cookie)
|
boolean |
allowFailedComponentRendezvous()
|
boolean |
allowIncrementalUpdateApppend()
|
void |
allowIncrementalUpdateApppend(boolean flag)
|
AWApplication |
application()
|
void |
applyValues()
|
void |
assertFileDownloadCompatibleRequestRequired()
|
AWBacktrackState |
backtrackState()
|
java.lang.String |
browserMaxWidth()
|
java.lang.String |
browserMinWidth()
|
void |
checkInExistingHttpSession()
|
static void |
cleanupThreadLocalState()
|
void |
clear()
|
boolean |
componentPathDebuggingEnabled()
|
java.lang.String |
cookieValueForKey(java.lang.String key)
|
javax.servlet.http.HttpSession |
createHttpSession()
|
AWComponent |
createPageWithName(java.lang.String name)
|
AWSession |
createSession()
Associates and returns a new AWSession. |
AWEncodedString |
currentElementId()
|
int |
currentElementIdLevel()
|
AWElementIdPath |
currentElementIdPath()
|
int |
currentElementIdPathLength()
|
java.lang.String |
currentElementIdTrace()
|
AWHtmlForm |
currentForm()
|
int |
currentPhase()
|
boolean |
dataValuePushedInInvokeAction()
|
java.lang.Object |
debugState()
Returns an object that will be toStringed when the debug information needs to be printed. |
AWDebugTrace |
debugTrace()
|
void |
dequeueSenderId()
|
java.util.Map |
dict()
Deprecated. use put(key,value) and get(key) API's directly |
boolean |
didAddCookies()
|
void |
disableComponentPathDebugging()
|
void |
disableElementIdGeneration()
Disable element id generation is used for non-interactive page rendering |
void |
enableComponentPathDebugging()
This may change during a request as not all components want this enabled. |
void |
enqueueSenderId(java.lang.String newId)
|
javax.servlet.http.HttpSession |
existingHttpSession()
|
AWSession |
existingSession()
Returns the session currently associated with this request context. |
void |
forceFullPageRefresh()
|
void |
forceRerender()
|
boolean |
forceRerenderRequired()
|
int |
formIndex()
|
java.lang.String |
formValueForKey(java.lang.String key)
|
java.util.Map |
formValues()
|
AWEncodedString |
frameName()
|
boolean |
fullPageRefreshRequired()
|
AWResponse |
generateResponse()
|
AWResponse |
generateResponse(AWResponse response)
|
java.lang.Object |
get(java.lang.String keyString)
|
AWComponent |
getCurrentComponent()
|
AWBaseElement |
getCurrentElement()
|
java.lang.String |
getDirectActionClassName()
|
java.lang.String |
getDirectActionName()
|
java.util.List |
getGlobalFormInputIdPaths()
|
UIRenderMeta.RenderVersion |
getQueryRenderVersion()
Fetch the render version set by the URL query parameters; usually null. |
int |
getTabIndex()
Fetch the tab index. |
AWResponse |
handleRequest(AWRequest request,
AWRequestHandler requestHandler)
|
boolean |
hasMoreSenderIds()
|
int |
historyAction()
|
javax.servlet.http.HttpSession |
httpSession()
|
javax.servlet.http.HttpSession |
httpSession(boolean required)
|
void |
incrementElementId()
|
void |
incrementElementId(int amount)
|
void |
incrementFormIndex()
|
void |
init(AWApplication application,
AWRequest request)
|
AWResponseGenerating |
invokeActionForRequest()
|
boolean |
isAccessibilityEnabled()
|
boolean |
isBrowserChrome()
|
boolean |
isBrowserFirefox()
|
boolean |
isBrowserMicrosoft()
|
boolean |
isBrowserSafari()
|
boolean |
isContentGeneration()
|
void |
isContentGeneration(boolean flag)
|
boolean |
isDebuggingEnabled()
|
boolean |
isExportMode()
|
boolean |
isHistoryRequest()
|
boolean |
isIncrementalUpdateRequest()
|
boolean |
isInPageRequest()
|
boolean |
isMetaTemplateMode()
|
boolean |
isPathDebugRequest()
|
boolean |
isPollUpdateRequest()
|
boolean |
isPrintMode()
|
boolean |
isRequestSecure()
|
boolean |
isStaticGeneration()
|
boolean |
isTabbed()
Evaluate the current URL is a tabbed one. |
boolean |
isTooManyTabRequest()
|
boolean |
isXMLHttpIncrementalRequest()
|
AWDebugTrace |
lastDebugTrace()
|
void |
markNextComponentAsMainInTrace()
|
AWEncodedString |
nextElementId()
|
AWElementIdPath |
nextElementIdPath()
|
AWPage |
page()
|
AWComponent |
pageComponent()
|
AWComponent |
pageWithName(java.lang.String pageName)
|
AWComponent |
pageWithName(java.lang.String pageName,
java.util.Map<java.lang.String,java.lang.Object> assignments)
|
javax.servlet.http.HttpSession |
peekHttpSession()
|
void |
popCurrentComponent(AWComponent parent)
|
void |
popCurrentElement(AWBaseElement prev)
|
void |
popElementIdLevel()
|
void |
popElementIdLevel(int elementIdComponent)
|
void |
popFormInputElementId()
|
void |
pushCurrentComponent(AWComponent component)
|
AWBaseElement |
pushCurrentElement(AWBaseElement element)
|
void |
pushElementIdLevel()
|
void |
pushElementIdLevel(int elementIdComponent)
|
void |
put(java.lang.String keyString,
java.lang.Object objectValue)
|
void |
recordFormInputId(AWElementIdPath elementIdPath)
|
void |
recordGlobalFormInputId(AWElementIdPath elementIdPath)
Keeps track of this element id for all subsequent forms and add the element id to all existing forms. |
void |
registerNewPageComponent(AWComponent pageComponent)
|
java.lang.Object |
remove(java.lang.String keyString)
|
AWRequest |
request()
|
AWPage |
requestPage()
|
java.lang.String |
requestSenderId()
|
AWElementIdPath |
requestSenderIdPath()
|
java.lang.String |
requestUrl()
|
void |
resetForNextCycle()
|
AWResponse |
response()
|
AWEncodedString |
responseId()
|
javax.servlet.http.HttpSession |
restoreHttpSessionForId(java.lang.String sessionId)
|
javax.servlet.http.HttpSession |
restoreHttpSessionForId(java.lang.String sessionId,
boolean checkRemoteHostAddress,
boolean throwException)
|
void |
restoreOriginalResponse(AWResponse response)
|
AWSession |
session()
|
AWSession |
session(boolean required)
Returns the current AWSession associated with the client making the request or, if if there is no current AWSession and required is true, throws AWSessionRestorationException. |
int |
sessionTimeout()
|
void |
setBacktrackState(AWBacktrackState backtrackState)
|
void |
setCurrentComponent(AWComponent currentComponent)
|
void |
setCurrentDirectAction(java.lang.String directActionClassName,
java.lang.String directActionName)
|
void |
setCurrentElement(AWBaseElement element)
Deprecated. use pushCurrentElement / popCurrentElement instead |
void |
setCurrentForm(AWHtmlForm currentForm)
|
void |
setDataValuePushedInInvokeAction(boolean value)
|
void |
setDebugIsInRecordingMode(boolean value)
|
void |
setElementId(AWElementIdGenerator elementIdGenerator)
The name of this "setElementId" is retained for backward compatibility with code in the ariba.encoder.xml package. |
void |
setExportMode(boolean isExportMode)
|
void |
setFormInputIds(AWArrayManager formInputIds)
|
void |
setFrameName(AWEncodedString frameName)
|
void |
setFrameName(java.lang.String frameName)
|
void |
setHistoryAction(int historyAction)
|
void |
setHistoryRequest(boolean historyRequest)
|
void |
setHttpSession(javax.servlet.http.HttpSession httpSession)
|
void |
setIsDebuggingEnabled(boolean state)
|
void |
setIsPrintMode(boolean isPrintMode)
|
void |
setMetaTemplateMode(boolean flag)
|
void |
setPage(AWPage page)
|
void |
setRequestPage(AWPage page)
|
void |
setResponse(AWResponse response)
|
void |
setResponseCompleteCallback(AWBaseResponse.AWResponseCompleteCallback callback)
|
void |
setXHRRCompatibleResponse(AWResponse response)
|
void |
sleep()
|
java.lang.String |
staticUrlForActionResults(AWResponseGenerating responseGenerating)
|
void |
stopComponentPathRecording()
|
void |
suppressTraceForCurrentScopingElement()
|
AWElementIdPath |
targetFormIdPath()
|
AWResponse |
temporarilySwapReponse(AWResponse response)
|
AWValidationContext |
validationContext()
|
boolean |
wasPathDebugRequest()
|
Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject |
---|
debugString, ensureFieldValuesClear, getFieldValue, init, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final AWEncodedString TopFrameName
public static final AWEncodedString SelfFrameName
public static final java.lang.String SessionIdKey
public static final java.lang.String ResponseIdKey
public static final java.lang.String SessionSecureIdKey
public static final java.lang.String SessionSecureIdKeyEquals
public static final java.lang.String FrameNameKey
public static final java.lang.String PageScrollTopKey
public static final java.lang.String PageScrollLeftKey
public static final java.lang.String SessionRendevousKey
public static final java.lang.String IncrementalUpdateKey
public static final ThreadDebugKey RequestContextID
public static final java.lang.String RefreshRequestKey
public static final java.lang.String RecordingModeKey
public static final java.lang.String InPageAction
public static final java.lang.String InPageRequest
public static boolean UseXmlHttpRequests
public static final java.lang.String IgnoreRefreshCompleteKey
public static final int Phase_ApplyValues
public static final int Phase_InvokeAction
public static final int Phase_Render
Constructor Detail |
---|
public AWRequestContext()
Method Detail |
---|
public void init(AWApplication application, AWRequest request)
public static AWRequestContext _requestContext()
public AWValidationContext validationContext()
public UIRenderMeta.RenderVersion getQueryRenderVersion()
public boolean isDebuggingEnabled()
public void setIsDebuggingEnabled(boolean state)
public void setMetaTemplateMode(boolean flag)
public boolean isMetaTemplateMode()
public void setPage(AWPage page)
public AWPage page()
public AWComponent pageComponent()
public AWComponent pageWithName(java.lang.String pageName)
public AWComponent pageWithName(java.lang.String pageName, java.util.Map<java.lang.String,java.lang.Object> assignments)
public void setRequestPage(AWPage page)
public AWPage requestPage()
public AWEncodedString responseId()
public void setFrameName(AWEncodedString frameName)
public void setFrameName(java.lang.String frameName)
public AWEncodedString frameName()
public void registerNewPageComponent(AWComponent pageComponent)
public void setElementId(AWElementIdGenerator elementIdGenerator)
elementIdGenerator
- public AWElementIdGenerator _getElementIdGenerator()
public void setBacktrackState(AWBacktrackState backtrackState)
public AWBacktrackState backtrackState()
public AWApplication application()
public AWSession existingSession()
public void setHttpSession(javax.servlet.http.HttpSession httpSession)
public javax.servlet.http.HttpSession existingHttpSession()
public javax.servlet.http.HttpSession createHttpSession()
public javax.servlet.http.HttpSession restoreHttpSessionForId(java.lang.String sessionId, boolean checkRemoteHostAddress, boolean throwException)
public javax.servlet.http.HttpSession restoreHttpSessionForId(java.lang.String sessionId)
public javax.servlet.http.HttpSession httpSession()
public javax.servlet.http.HttpSession httpSession(boolean required)
public AWSession session(boolean required)
required
- public AWSession session()
public AWSession createSession()
public javax.servlet.http.HttpSession peekHttpSession()
public AWRequest request()
public void _overrideRequest(AWRequest newRequest)
public void setResponse(AWResponse response)
public AWResponse temporarilySwapReponse(AWResponse response)
public void restoreOriginalResponse(AWResponse response)
public void setXHRRCompatibleResponse(AWResponse response)
public AWResponse response()
public boolean isBrowserFirefox()
public boolean isBrowserMicrosoft()
public boolean isBrowserSafari()
public boolean isBrowserChrome()
public java.lang.String browserMinWidth()
public java.lang.String browserMaxWidth()
public java.lang.String requestSenderId()
public AWElementIdPath requestSenderIdPath()
public void dequeueSenderId()
public void enqueueSenderId(java.lang.String newId)
public boolean hasMoreSenderIds()
public AWElementIdPath nextElementIdPath()
public AWEncodedString nextElementId()
public AWElementIdPath currentElementIdPath()
public AWEncodedString currentElementId()
public int currentElementIdPathLength()
public void incrementElementId()
public void incrementElementId(int amount)
public void pushElementIdLevel(int elementIdComponent)
public void pushElementIdLevel()
public void popElementIdLevel()
public void popElementIdLevel(int elementIdComponent)
public int currentElementIdLevel()
public void disableElementIdGeneration()
public java.lang.String currentElementIdTrace()
public void setFormInputIds(AWArrayManager formInputIds)
public void recordFormInputId(AWElementIdPath elementIdPath)
public void recordGlobalFormInputId(AWElementIdPath elementIdPath)
elementIdPath
- public java.util.List getGlobalFormInputIdPaths()
public AWElementIdPath targetFormIdPath()
public void popFormInputElementId()
public void resetForNextCycle()
public void applyValues()
public AWResponseGenerating invokeActionForRequest()
public boolean isPollUpdateRequest()
public boolean isInPageRequest()
public AWResponse generateResponse(AWResponse response)
public void addCookie(AWCookie cookie)
public boolean didAddCookies()
public AWResponse generateResponse()
public AWResponse handleRequest(AWRequest request, AWRequestHandler requestHandler)
public void checkInExistingHttpSession()
public void sleep()
public java.lang.Object get(java.lang.String keyString)
public void put(java.lang.String keyString, java.lang.Object objectValue)
public java.lang.Object remove(java.lang.String keyString)
public void clear()
public void setCurrentForm(AWHtmlForm currentForm)
public AWHtmlForm currentForm()
public void incrementFormIndex()
public int formIndex()
public java.lang.Object debugState()
DebugState
The most common implementation is to create a new Map and set key and value pairs of information in that Map which it will then return.
debugState
in interface DebugState
ThreadDebugState.set(ariba.util.core.ThreadDebugKey, java.lang.Object)
public void setCurrentDirectAction(java.lang.String directActionClassName, java.lang.String directActionName)
public java.lang.String getDirectActionClassName()
public java.lang.String getDirectActionName()
public void setCurrentComponent(AWComponent currentComponent)
public AWComponent getCurrentComponent()
public void setCurrentElement(AWBaseElement element)
public AWBaseElement pushCurrentElement(AWBaseElement element)
public void popCurrentElement(AWBaseElement prev)
public AWBaseElement getCurrentElement()
public void enableComponentPathDebugging()
public void disableComponentPathDebugging()
public boolean componentPathDebuggingEnabled()
public AWDebugTrace debugTrace()
public int currentPhase()
public AWDebugTrace lastDebugTrace()
public void pushCurrentComponent(AWComponent component)
public void popCurrentComponent(AWComponent parent)
public void suppressTraceForCurrentScopingElement()
public void markNextComponentAsMainInTrace()
public boolean isPathDebugRequest()
public boolean wasPathDebugRequest()
public void stopComponentPathRecording()
public void _debugPushSemanticKeyPrefix()
public void _debugPopSemanticKeyPrefix()
public void _debugSetSemanticKeyPrefix(java.lang.String prefix)
public java.lang.String _debugSemanticKeyPrefix()
public AWEncodedString _debugResponseIdAsIs()
public boolean _debugIsInPlaybackMode()
public boolean _debugIsInRecordingMode()
public void setDebugIsInRecordingMode(boolean value)
public void _debugSkipRecordPlayback()
public boolean _debugShouldRecord()
public static void cleanupThreadLocalState()
public java.lang.String cookieValueForKey(java.lang.String key)
public java.lang.String formValueForKey(java.lang.String key)
public java.util.Map formValues()
public boolean isRequestSecure()
public AWComponent createPageWithName(java.lang.String name)
public int sessionTimeout()
public java.lang.String requestUrl()
public boolean isPrintMode()
public void setIsPrintMode(boolean isPrintMode)
public boolean isExportMode()
public void setExportMode(boolean isExportMode)
public void setDataValuePushedInInvokeAction(boolean value)
public boolean dataValuePushedInInvokeAction()
public boolean isIncrementalUpdateRequest()
public boolean isXMLHttpIncrementalRequest()
public void assertFileDownloadCompatibleRequestRequired()
public boolean allowFailedComponentRendezvous()
public boolean isContentGeneration()
public void isContentGeneration(boolean flag)
public void forceFullPageRefresh()
public boolean fullPageRefreshRequired()
public void forceRerender()
public boolean forceRerenderRequired()
public boolean allowIncrementalUpdateApppend()
public void allowIncrementalUpdateApppend(boolean flag)
public void setHistoryRequest(boolean historyRequest)
public boolean isHistoryRequest()
public void setHistoryAction(int historyAction)
public int historyAction()
public java.util.Map dict()
public void setResponseCompleteCallback(AWBaseResponse.AWResponseCompleteCallback callback)
public boolean isAccessibilityEnabled()
public boolean isStaticGeneration()
public boolean isTabbed()
public int getTabIndex()
public java.lang.String staticUrlForActionResults(AWResponseGenerating responseGenerating)
public boolean isTooManyTabRequest()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |