public class DynamoHttpServletRequest extends MutableHttpServletRequest implements NameResolver, atg.servlet.exittracking.ExitTrackingHandler, ApplicationLogging
This is an HttpServletRequest implementation that wrappers another HttpServletRequest object providing an enhanced API for Dynamo programmers. It extends HttpServletRequest and provides additional functionality for:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTRIBUTE_NAME
The name used to store this request as an attribute of the underlying request
|
static java.lang.String |
CERTIFICATES_ATTRIBUTE
The attribute name used to store the parsed X509 certificates
|
static java.lang.String |
CIPHER_SUITE_ATTR
The attribute name used to store the cipher suite
|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
COOKIE_ATTRIBUTE_NAME
The request attribute used to hold the cookie Dictionary
|
static java.lang.String |
CURRENT_SERVLET_NAME_ATTRIBUTE |
static java.lang.String |
DEFAULT_DISPATCH_SERVLET
This attribute will contains the default servlet to be used to dispatch
servlets from a request dispatcher.
|
static java.lang.String |
DEFAULT_PARAMETER_DELIMITER
Default URL Parameter Delimiter
|
static int |
ENCODE_CONTEXT_PATH |
static int |
ENCODE_IF_NOT_THERE |
static int |
ENCODE_NONE |
static java.lang.String |
ERROR_EXCEPTION_ATTRIBUTE |
static java.lang.String |
ERROR_EXCEPTION_TYPE_ATTRIBUTE |
static java.lang.String |
ERROR_MESSAGE_ATTRIBUTE |
static java.lang.String |
ERROR_REQUEST_URI_ATTRIBUTE |
static java.lang.String |
ERROR_SERVLET_NAME_ATTRIBUTE |
static java.lang.String |
ERROR_STATUS_ATTRIBUTE |
static java.lang.String |
FORM_EVENTS_SENT_ATTRIBUTE |
static java.lang.String |
GLOBAL_SCOPE |
static java.lang.String |
INCLUDE_CONTEXT_PATH_ATTRIBUTE
The attribute name used to store the context path of an include
|
static java.lang.String |
INCLUDE_PATH_INFO_ATTRIBUTE
The attribute name used to store the path info of an include
|
static java.lang.String |
INCLUDE_PATH_TRANSLATED_ATTRIBUTE
The attribute name used to store the path translated of an include
|
static java.lang.String |
INCLUDE_QUERY_STRING_ATTRIBUTE
The attribute name used to store the query string of an include
|
static java.lang.String |
INCLUDE_REQUEST_URI_ATTRIBUTE
The attribute name used to store the request uri of an include
|
static java.lang.String |
INCLUDE_SERVLET_PATH_ATTRIBUTE
The attribute name used to store the servlet path of an include
|
static java.lang.String |
INVALID_REMOTEADDR
bug 75571, if we enable VerifyRemoteAddr, we need to set this attribute to true if the remote address is
invalid.
|
static java.lang.String |
KEY_SIZE_ATTR
The attribute name used to store the size of the key
|
static java.lang.String |
LAYERING_REMAP_ATTRIBUTE_NAME
This attribute is used to contain a map used for web app layering.
|
static java.lang.String |
OBJECT_PARAMETER_ATTRIBUTE_NAME
The request attribute used to hold object parameters
|
static int |
PAGE_EVENT_MASK
Flag indicating that page-related JMS events should be fired w/r/t
this request.
|
static java.lang.String |
PAGE_FRAGMENT_SUBSTITUTER_ATTRIBUTE
This attribute contains the
PageFragmentSubstituter . |
static java.lang.String |
PATH_TRANSLATOR
The name of the attribute to use for translating paths.
|
static int |
PROFILE_EVENT_MASK
Flag indicating that profile-related JMS events should be fired w/r/t
this request.
|
static java.lang.String |
PROTOTYPE_SCOPE |
static java.lang.String |
REQUEST_CONTEXT_NAME
The name of the request in the request scope tree.
|
static java.lang.String |
REQUEST_SCOPE |
static int |
SESSION_EVENT_MASK
Flag indicating that session-related JMS events should be fired w/r/t
this request.
|
static java.lang.String |
SESSION_INVALIDATED
bug 72198, workaround weblogic session backup problem.
|
static java.lang.String |
SESSION_SCOPE |
static java.lang.String |
URL_ARGUMENT_ATTRIBUTE_NAME
The request attribute used to hold the URL argument Dictionary
|
static java.lang.String |
URL_PARAMETER_ARGNAME
The constant used to identify the Scrambled parameter in the URL string
|
static java.lang.String |
URL_PARAMETER_SPECIFIER |
static java.lang.String |
WINDOW_CONTEXT_NAME
The name of the window in the window scope tree.
|
static java.lang.String |
WINDOW_ID_PARAM_NAME |
static java.lang.String |
WINDOW_SCOPE |
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
DynamoHttpServletRequest()
Constructs a new DynamoHttpServletRequest.
|
Modifier and Type | Method and Description |
---|---|
void |
addPersistentQueryParameter(java.lang.String pKey,
java.lang.String pValue)
Adds a persistent query parameter which will be encoded in all
subsequent calls to encodeURL.
|
void |
addQueryParameter(java.lang.String pKey,
java.lang.String pValue)
Adds a query parameter which will be encoded in the next call
to encodeURL
|
void |
addURLParameter(java.lang.String pKey,
java.lang.String pValue)
Adds a URL parameter which will be encoded in the next call
to encodeURL
|
java.lang.String |
encodeURL(java.lang.String pURL)
Encodes a URL with all the accumulated parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pClearParameters)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL,
boolean pInterpretURIs)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL,
boolean pInterpretURIs,
boolean pDoExitTracking)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL,
boolean pInterpretURIs,
boolean pDoExitTracking,
boolean pUseReverseMap)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL,
boolean pInterpretURIs,
boolean pDoExitTracking,
int pPrependMode)
Encodes a URL with all the accumulated Parameters.
|
java.lang.String |
encodeURL(java.lang.String pURL,
boolean pEncodeParameters,
boolean pClearParameters,
boolean pIsImageURL,
boolean pInterpretURIs,
boolean pDoExitTracking,
int pPrependMode,
boolean pUseReverseMap)
Encodes a URL with all the accumulated Parameters.
|
void |
endRequest()
Clean up after the request once it has finished.
|
java.lang.String |
getBaseDirectory()
Returns the current base directory or null if it is not set
|
BrowserTyper |
getBrowserTyper()
Returns the BrowserTyper
|
ComponentName |
getContextNamePath()
Returns the context name path (a ComponentName).
|
java.lang.String |
getCookieParameter(java.lang.String pKey)
Returns the first parameter matching the given key from the HTTP Cookies
sent by the browser.
Causes the cookies headers to be parsed and cached if they weren't already. |
java.lang.String |
getCookieParameter(java.lang.String pKey,
int pIndex)
Returns the nth Cookie parameter matching the given key and index.
|
int |
getCookieParameterCount(java.lang.String pKey)
Returns the number of Cookie parameters that have the same key.
Causes the cookies headers to be parsed and cached if they weren't already. |
java.util.Enumeration |
getCookieParameterNames()
Returns an enumeration of Strings of all of the Cookie parameter names.
Causes the cookies headers to be parsed and cached if they weren't already. |
java.lang.String[] |
getCookieParameterValues(java.lang.String pKey)
Returns an array of Strings of all the Cookie parameter values
for the given name.
Causes the cookie headers to parsed and cached if it wasn't already. |
javax.servlet.http.Cookie[] |
getCookies()
Gets the array of cookies found in this request.
|
int |
getCountOfFrames() |
java.util.Map |
getCurrentFrameWithoutNulls(boolean pCopy)
Return a Map that represents the current frame of the param stack.
|
boolean |
getDisableExitTracking() |
java.lang.String |
getDocRootServicePrefix() |
int |
getEncodeContextPathMode()
Returns the EncodeContextPathMode property.
|
boolean |
getEncodeServletPath()
Returns the EncodeServletPath property.
|
boolean |
getEncodeURL()
Returns the flag that indicates whether or not this request is
currently encoding URLs
|
int |
getEventFlags() |
atg.servlet.exittracking.ExitTrackingHandler |
getExitTrackingHandler()
Returns the exit tracking handler
|
java.lang.String |
getExitTrackingParameterName()
Returns the parameter name which holds the URL to redirect to as part
of the exit tracking process.
|
boolean |
getFormEventsSent() |
boolean |
getGenerateRequestLocales()
This value gets set by the HeadPipelineServlet when the request
is initially created.
|
java.lang.String |
getLinkEncoding() |
java.lang.Object |
getLocalParameter(ParameterName pName)
Get the parameter associated with the current parameter frame (
the one associated with the current droplet, or the top-level if
there is no droplet).
|
java.lang.Object |
getLocalParameter(java.lang.String pName) |
ApplicationLogging |
getLog()
Returns the Log property
|
java.util.Map |
getMapCopyOfCurrentFrame()
Return a Map that represents the current frame of the param stack.
|
java.util.Map |
getMapForCurrentFrame()
Return a Map that represents the current frame of the param stack.
|
java.lang.String |
getMimeType()
Returns the mimetype of this particular request file
|
MimeTyper |
getMimeTyper()
Returns the MimeTyper property
|
atg.nucleus.MultiRootNameResolverFactory |
getMultiNucleusNameResolverFactory()
Returns property multiNucleusNameResolverFactory.
|
atg.nucleus.ResolveNameHelper |
getMultiNucleusResolveNameHelper()
Returns property multiNucleusResolveNameHelper.
|
atg.nucleus.MultiRootNameResolverFactory |
getNameResolverFactory()
Returns property nameResolverFactory.
|
Nucleus |
getNucleus()
Returns the Nucleus
|
static java.lang.Object |
getNullParameterObject()
Returns the parameter Object that represents a null value when
placed into a parameter dictionary.
|
java.lang.Object |
getObjectParameter(ParameterName pName)
Returns the parameter with the given name.
|
java.lang.Object |
getObjectParameter(java.lang.String pName)
Returns the parameter with the given name.
|
java.lang.Object |
getObjectURLParameter(java.lang.String pKey,
int pIndex)
Returns the nth URL parameter matching the given key and index as
an object.
|
java.lang.String |
getParameter(ParameterName pName)
Returns a parameter of the request given the specified name.
|
java.lang.String |
getParameter(java.lang.String pName)
Returns a parameter of the request given the specified name.
|
java.lang.String |
getParameterDelimiter()
Returns the parameterDelimiter property
|
java.util.Enumeration |
getParameterNames()
Returns an enumeration of strings representing the parameter
names for this request.
|
java.util.Enumeration |
getParameterNamesInStack()
This method iterates through the mParameterStack and returns an
enumeration of all of the parameter names which are defined in
the current scope, i.e.
|
java.lang.String[] |
getParameterValues(java.lang.String pName)
Returns the values of the specified parameter for the request as
an array of strings, or null if the named parameter does not
exist.
|
java.util.Map |
getParamMapForTopFrame()
Return a Map representing the parameters in the current
frame of the droplet parameter stack.
|
java.lang.String |
getPostParameter(java.lang.String pKey)
Returns the first parameter matching the given key from the Post data,
or null if the key is not found.
Causes the Post data to parsed and cached if it wasn't already. |
java.lang.String |
getPostParameter(java.lang.String pKey,
int pIndex)
Returns the nth Post parameter matching the given key and index.
|
int |
getPostParameterCount(java.lang.String pKey)
Returns the number of Post parameters that have the same key.
Causes the Post data to parsed and cached if it wasn't already. |
java.util.Enumeration |
getPostParameterNames()
Returns an enumeration of Strings of all of the Post parameter names.
Causes the Post data to parsed and cached if it wasn't already. |
java.lang.String[] |
getPostParameterValues(java.lang.String pKey)
Returns an array of Strings of all the Post parameter values
for the given name.
Causes the Post data to parsed and cached if it wasn't already. |
java.lang.String |
getQueryParameter(java.lang.String pKey)
Returns the first parameter matching the given key from the Query String,
or null if the key is not found.
|
java.lang.String |
getQueryParameter(java.lang.String pKey,
int pIndex)
Returns the nth Query parameter matching the given key and index.
|
int |
getQueryParameterCount(java.lang.String pKey)
Returns the number of Query parameters that have the same key.
Causes the Query String to parsed and cached if it wasn't already. |
java.util.Enumeration |
getQueryParameterNames()
Returns an enumeration of Strings of all of the Query parameter names.
Causes the Query String to parsed and cached if it wasn't already. |
java.lang.String[] |
getQueryParameterValues(java.lang.String pKey)
Returns an array of Strings of all the Query parameter values
for the given name.
Causes the Query String to parsed and cached if it wasn't already. |
java.lang.String |
getRealPath(java.lang.String pPath)
Wraps the call to getRealPath
|
atg.servlet.pipeline.RedirectURLValidatorService |
getRedirectURLValidator()
Returns property redirectURLValidator.
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(javax.servlet.ServletContext pContext,
java.lang.String pPath)
Returns a RequestDispatcher object that acts as a wrapper for
the resource located at the given path and in the given servlet context.
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String pPath)
Returns a RequestDispatcher object that acts as a wrapper for
the resource located at the given path.
|
java.lang.String |
getRequestedSessionId()
Gets the session id specified with this request.
|
DynamoHttpServletRequest |
getRequestForComparison()
Returns a reference to this.
|
atg.servlet.RequestLocale |
getRequestLocale()
Returns the request locale
|
ComponentName |
getRequestLocalePath()
This value gets set by the HeadPipelineServlet when the request
is initially created.
|
NameContext |
getRequestScope() |
RequestScopeManager |
getRequestScopeManager()
Returns the RequestScopeManager
|
java.lang.String |
getRequestURI()
Overrides MutableHttpServletRequest to check whether we are
returning requestURI according to the specification or whether we
returning Dynamo's "old style" requestURI, which included query
args.
|
java.lang.String |
getRequestURIWithQueryString()
Returns the first line of the HTTP request.
|
atg.nucleus.ResolveNameHelper |
getResolveNameHelper()
The helper class used by MultiRootNameResolverFactory...
|
DynamoHttpServletResponse |
getResponse() |
java.lang.String |
getRestorableSessionIdFromURL()
Gets the session id taken from the URL which, if it differs from
requestedSessionID, indicates the need to restore a session.
|
byte[] |
getScrambleKey()
Returns the Scramble Key property
|
javax.servlet.http.HttpSession |
getSession()
Returns the current session associated with this request,
or if the request does not have a session, creates one.
|
javax.servlet.http.HttpSession |
getSession(boolean create)
Gets the current valid session associated with this request, if
create is false or, if necessary, creates a new session for the
request, if create is true.
|
long |
getSessionConfirmationNumber()
Get the session confirmation number.
|
NameContext |
getSessionNameContext()
Return the session name context.
|
HttpSessionRequest |
getSessionRequest()
Deprecated.
|
HttpSessionRequest |
getSessionRequest(boolean pCreate)
Deprecated.
|
java.lang.String |
getURLParameter(java.lang.String pKey)
Returns the first parameter matching the given key from Dynamo's special
scrambled URL Parameter string, or null if the key is not found.
Causes the URL Parameter string to be parsed and cached if it wasn't already. |
java.lang.String |
getURLParameter(java.lang.String pKey,
int pIndex)
Returns the nth URL parameter matching the given key and index.
|
int |
getURLParameterCount(java.lang.String pKey)
Returns the number of URL parameters that have the same key.
Causes the URL String to parsed and cached if it wasn't already. |
java.util.Enumeration |
getURLParameterNames()
Returns an enumeration of Strings of all of the URL parameter names.
Causes the URL String to parsed and cached if it wasn't already. |
java.lang.String |
getURLParameterString()
Returns the URL Parameter String property string
|
java.lang.String[] |
getURLParameterValues(java.lang.String pKey)
Returns an array of Strings of all the Dynamo's special scrambled URL
parameter values for the given name.
Causes the URL String to parsed and cached if it wasn't already. |
java.lang.String |
getURLSessionIdSpecifier()
Returns the URL Session ID Specifier
|
UserAuthenticator |
getUserAuthenticator()
Returns the user authenticator to use if we are running in DAF
|
java.security.Principal |
getUserPrincipal()
Overrides getUserPrincipal in MutableHttpServletRequest.
|
atg.servlet.minimal.WebApplicationInterface |
getWebApplication()
Return the J2EE WebApplicationInterface associated with this request
(if any).
|
NameContext |
getWindowScope() |
atg.nucleus.WindowScopeManager |
getWindowScopeManager()
Returns the WindowScopeManager
|
java.lang.String |
getWorkingDirectory()
Returns the current request's working directory, which always ends in "/"
|
javax.servlet.ServletRequestWrapper |
getWrapper()
Returns the ServletRequestWrapper wrapping this
request.
|
boolean |
hasRequestScope()
Returns true if this request has had a request scope created for it yet.
|
boolean |
isAfterGetsClaimed() |
boolean |
isBrowserType(java.lang.String pFeature)
Returns true if the browser supports the given feature
|
boolean |
isDelayedRequest()
Returns the isDelayedRequest property
|
boolean |
isDynamoPipeline() |
boolean |
isInitialized()
Returns true if this object is initialized.
|
boolean |
isInTemplatePage() |
boolean |
isLoggingDebug()
This method returns whether or not an debug log event should be
broadcast.
|
boolean |
isLoggingError()
This method returns whether or not an error log event should be
broadcast.
|
boolean |
isLoggingInfo()
This method returns whether or not an info log event should be
broadcast.
|
boolean |
isLoggingWarning()
This method returns whether or not an warning log event should be
broadcast.
|
boolean |
isRequestedSessionIdFromCookie()
Checks whether the session id specified by this request came in
as a cookie.
|
boolean |
isRequestedSessionIdFromUrl()
Checks whether the session id specified by this request came in
as part of the URL.
|
boolean |
isRequestedSessionIdValid()
Checks whether this request is associated with a session that
is valid in the current session context.
|
boolean |
isUserInRole(java.lang.String pRole)
Overrides isUserInRole in MutableHttpServletRequest.
|
java.lang.Boolean |
isUseXmlParamDelimiter()
Gets property useXmlParamDelimiter.
|
void |
logDebug(java.lang.String pMessage)
Logs an debug event with the specified message
|
void |
logDebug(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an debug event with the specified message and Throwable
|
void |
logDebug(java.lang.Throwable pThrowable)
Logs an debug event with the specified Throwable
|
void |
logError(java.lang.String pMessage)
Logs an error event with the specified message
|
void |
logError(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an error event with the specified message and Throwable
|
void |
logError(java.lang.Throwable pThrowable)
Logs an error event with the specified Throwable
|
void |
logInfo(java.lang.String pMessage)
Logs an info event with the specified message
|
void |
logInfo(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an info event with the specified message and Throwable
|
void |
logInfo(java.lang.Throwable pThrowable)
Logs an info event with the specified Throwable
|
void |
logWarning(java.lang.String pMessage)
Logs an warning event with the specified message
|
void |
logWarning(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an warning event with the specified message and Throwable
|
void |
logWarning(java.lang.Throwable pThrowable)
Logs an warning event with the specified Throwable
|
java.lang.String |
performExitTracking(java.lang.String pURL)
Returns an encoded URL that can be decoded by the exit tracking handler
|
void |
popDefaultParameters()
Pops the first dictionary for this frame off the stack.
|
void |
popFrame()
When the frame is complete, this pops the parameter stack back to
the state before the pushFrame.
|
void |
popParameters()
Pops the dictionary of parameters on top of the stack.
|
void |
printRequest(java.io.PrintStream pOut)
Prints all the elements of the request
|
void |
pushDefaultParameters(java.util.Dictionary pDict)
This sets a new dictionary of parameters at the top of the current
frame.
|
void |
pushFrame()
A frame is defined for each droplet invocation.
|
void |
pushParameters(java.util.Dictionary pDict)
Adds a dictionary to the list of parameters to check.
|
java.lang.Object |
removeParameter(java.lang.String pName)
Removes the definition of the parameter specified.
|
void |
removePersistentQueryParameter(java.lang.String pKey)
Removes a persistent query parameter, which will no longer be
encoded in any subsequent calls to encodeURL.
|
void |
removeSessionFromRequest()
Deprecated.
|
java.lang.Object |
resolveGlobalName(ComponentName pName)
Deprecated.
You should use resolveName to resolve references to
globally scoped components.
|
java.lang.Object |
resolveGlobalName(java.lang.String pName)
Deprecated.
You should use resolveName to resolve references to
globally scoped components.
|
java.lang.Object |
resolveName(ComponentName pName)
Resolves a name in the nucleus hierarchy searching session, global,
window and request scopes.
|
java.lang.Object |
resolveName(ComponentName pName,
boolean pCreate)
Resolves a name in the nucleus hierarchy searching session, global,
window and request scopes.
|
java.lang.Object |
resolveName(java.lang.String pName)
Resolves a name in the nucleus hierarchy searching session, global,
and request scopes.
|
java.lang.Object |
resolveName(java.lang.String pName,
boolean pCreate)
Resolves a name in the nucleus hierarchy searching session, global,
and request scopes.
|
java.lang.Object |
resolveRequestName(ComponentName pName)
Deprecated.
You should use resolveName to resolve references to
request scoped components.
|
java.lang.Object |
resolveRequestName(java.lang.String pName)
Deprecated.
You should use resolveName to resolve references to
request scoped components.
|
java.lang.Object |
resolveSessionName(ComponentName pName)
Deprecated.
You should use resolveName to resolve references to
session scoped components.
|
java.lang.Object |
resolveSessionName(java.lang.String pName)
Deprecated.
You should use resolveName to resolve references to
session scoped components.
|
java.lang.String |
reverseMapContextRootForLayering(java.lang.String strFinalURL) |
boolean |
serviceLocalParameter(ParameterName pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
boolean |
serviceLocalParameter(java.lang.String pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
boolean |
serviceParameter(ParameterName pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
boolean |
serviceParameter(ParameterName pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes,
TagConverter pCvt,
java.util.Properties pCvtArgs)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
boolean |
serviceParameter(java.lang.String pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
boolean |
serviceParameter(java.lang.String pName,
javax.servlet.ServletRequest pReq,
javax.servlet.ServletResponse pRes,
TagConverter pCvt,
java.util.Properties pCvtArgs)
This is a convenience function for putting the value of
a specified parameter to the output stream.
|
void |
setAfterGetsClaimed(boolean pAfterGetsClaimed)
Flag indicating if someone in the request has taken
responsibility for calling the afterGets methods.
|
void |
setBaseDirectory(java.lang.String pBaseDir)
Sets the base directory.
|
void |
setBrowserTyper(BrowserTyper pBrowserTyper)
Sets the BrowserTyper
|
void |
setDisableExitTracking(boolean pDisableExitTracking)
If true, forces exit tracking to not be performed on this
request.
|
void |
setDocRootServicePrefix(java.lang.String pDocRootServicePrefix) |
void |
setDynamoPipeline(boolean pDynamoPipeline)
Sets the property dynamoPipeline.
|
void |
setEncodeContextPathMode(int pEncodeMode)
Sets the EncodeContextPathMode property.
|
void |
setEncodeServletPath(boolean pEncode)
Sets the EncodeServletPath property.
|
void |
setEncodeURL(boolean pEncodeURL)
Enables or disables the rewriting of subsequent URLs that are
processed by this request.
|
void |
setEventFlags(int pEventFlags)
Change the set of JMS events that are enabled for firing with
respect to this request.
|
void |
setExitTrackingHandler(atg.servlet.exittracking.ExitTrackingHandler pExitTrackingHandler)
Sets the exit tracking handler
|
void |
setFormEventsSent(boolean pFormEventsSent)
Sets the property FormEventsSent.
|
void |
setGenerateRequestLocales(boolean pValue)
This value gets set by the HeadPipelineServlet when the request
is initially created.
|
void |
setInitialized(boolean pInitialized)
Sets the property Initialized.
|
void |
setInTemplatePage(boolean pInTemplatePage)
Sets the property InTemplatePage.
|
void |
setLinkEncoding(java.lang.String pLinkEncoding)
Sets the property LinkEncoding.
|
void |
setLog(ApplicationLogging pLog)
Sets the Log property
|
void |
setLoggingDebug(boolean pLogging)
Sets whether or not error log events should be logged.
|
void |
setLoggingError(boolean pLogging)
Sets whether or not error log events should be logged.
|
void |
setLoggingInfo(boolean pLogging)
Sets whether or not info log events should be logged.
|
void |
setLoggingWarning(boolean pLogging)
Sets whether or not warning log events should be logged.
|
void |
setMimeType(java.lang.String pMimeType)
Sets the mime type in the request.
|
void |
setMimeTyper(MimeTyper pMimeTyper)
Sets the MimeTyper property
|
void |
setMultiNucleusNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pMultiNucleusNameResolverFactory)
Sets property multiNucleusNameResolverFactory.
|
void |
setNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pNameResolverFactory)
Sets property nameResolverFactory.
|
void |
setNucleus(Nucleus pNucleus)
Sets the Nucleus
|
void |
setParameter(java.lang.String pName,
java.lang.Object pValue)
Sets the value of a request parameter.
|
void |
setParameter(java.lang.String pName,
java.lang.Object pValue,
TagConverter pCvt,
java.util.Properties pCvtArgs)
Sets the value of a request parameter.
|
void |
setParameterDelimiter(java.lang.String pParameterDelimiter)
Sets the parameterDelimiter property
|
void |
setParameterHandler(atg.servlet.ParameterHandler pParameterHandler)
Sets the parameter handler
|
void |
setRedirectURLValidator(atg.servlet.pipeline.RedirectURLValidatorService pRedirectURLValidator)
Sets property redirectURLValidator.
|
void |
setRequest(javax.servlet.http.HttpServletRequest pRequest)
Sets the HttpServletRequest embedded by this
|
void |
setRequestLocale(atg.servlet.RequestLocale pLocale)
Sets the request locale
|
void |
setRequestLocalePath(ComponentName pValue)
This value gets set by the HeadPipelineServlet when the request
is initially created.
|
void |
setRequestScope(NameContext pRequestScope)
Sets the property RequestScope.
|
void |
setRequestScopeManager(RequestScopeManager pRequestScopeManager)
Sets the RequestScopeManager
|
void |
setRequestURIHasQueryString(boolean pRequestURIHasQueryString)
The servlet specification requires that the requestURI
not contain query args.
|
void |
setResolveNameHelper(atg.nucleus.ResolveNameHelper pResolveNameHelper)
The helper class used by MultiRootNameResolverFactory...
|
void |
setResponse(DynamoHttpServletResponse pResponse)
Sets the property Response.
|
void |
setRestorableSessionIdFromURL(java.lang.String pRestorableSessionIdFromURL)
Sets the session id taken from the URL which, if it differs from
requestedSessionID indicates the need to restore a session.
|
void |
setScrambleKey(byte[] pScrambleKey)
Sets the Scramble Key property
|
void |
setSessionRequest(HttpSessionRequest pSessionRequest) |
void |
setupLoopbackTemplateEmailRequest()
Determines if this request is a loopback request made by the
template email system, and if so, alters its state appropriately.
|
void |
setURLSessionIdSpecifier(java.lang.String pURLSessionIdSpecifier)
Sets the URL Session ID Specifier
|
void |
setUserAuthenticator(UserAuthenticator pUserAuthenticator)
Sets the user authenticator to use if we are running in DAF
|
void |
setUseXmlParamDelimiter(java.lang.Boolean pUseXmlParamDelimiter)
Sets property useXmlParamDelimiter.
|
void |
setWebApplication(atg.servlet.minimal.WebApplicationInterface pWebApplication)
Set the J2EE WebApplicationInterface associated with this request.
|
void |
setWindowScopeManager(atg.nucleus.WindowScopeManager pScopeManager)
Sets the WindowScopeManager
|
void |
setWrapper(javax.servlet.ServletRequestWrapper pWrapper)
Sets the ServletRequestWrapper wrapping this
request.
|
boolean |
shouldExitTrack(java.lang.String pURL)
Returns true if the supplied URL should be exit tracked
|
protected void |
swapRequest(javax.servlet.http.HttpServletRequest pRequest)
Swaps in a new wrapped request objet
without reseting this request.
|
boolean |
tamperedURLParameters()
Returns true if the special Dynamo URL parameters could not be properly
decoded.
|
java.lang.String |
toString()
Return the string representation.
|
getAttribute, getAttribute, getAttributeNames, getAuthType, getCharacterEncoding, getContentLength, getContentType, getContextPath, getDateHeader, getHeader, getHeaderNames, getHeaders, getInputStream, getIntHeader, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getMethod, getParameterMap, getPathInfo, getPathTranslated, getPermanentAttribute, getProtocol, getQueryString, getReader, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequest, getRequestURL, getScheme, getServerName, getServerPort, getServletPath, isRequestedSessionIdFromURL, isRequestURISet, isSecure, removeAttribute, setAttribute, setAttributeFactory, setAuthType, setCharacterEncoding, setContentLength, setContentType, setContextPath, setInputStream, setMethod, setPathInfo, setPathTranslated, setProtocol, setQueryString, setRemoteAddr, setRemoteHost, setRemoteUser, setRequestURI, setScheme, setServerName, setServerPort, setServletPath
public static final java.lang.String CLASS_VERSION
public static final java.lang.String ATTRIBUTE_NAME
public static final java.lang.String INCLUDE_REQUEST_URI_ATTRIBUTE
public static final java.lang.String INCLUDE_CONTEXT_PATH_ATTRIBUTE
public static final java.lang.String INCLUDE_SERVLET_PATH_ATTRIBUTE
public static final java.lang.String INCLUDE_PATH_INFO_ATTRIBUTE
public static final java.lang.String INCLUDE_QUERY_STRING_ATTRIBUTE
public static final java.lang.String INCLUDE_PATH_TRANSLATED_ATTRIBUTE
public static final java.lang.String CERTIFICATES_ATTRIBUTE
public static final java.lang.String KEY_SIZE_ATTR
public static final java.lang.String CIPHER_SUITE_ATTR
public static final java.lang.String ERROR_STATUS_ATTRIBUTE
public static final java.lang.String ERROR_MESSAGE_ATTRIBUTE
public static final java.lang.String ERROR_EXCEPTION_TYPE_ATTRIBUTE
public static final java.lang.String ERROR_EXCEPTION_ATTRIBUTE
public static final java.lang.String ERROR_SERVLET_NAME_ATTRIBUTE
public static final java.lang.String ERROR_REQUEST_URI_ATTRIBUTE
public static final java.lang.String CURRENT_SERVLET_NAME_ATTRIBUTE
public static final java.lang.String FORM_EVENTS_SENT_ATTRIBUTE
public static final java.lang.String OBJECT_PARAMETER_ATTRIBUTE_NAME
public static final java.lang.String URL_ARGUMENT_ATTRIBUTE_NAME
public static final java.lang.String COOKIE_ATTRIBUTE_NAME
public static final java.lang.String PATH_TRANSLATOR
public static final java.lang.String LAYERING_REMAP_ATTRIBUTE_NAME
public static final java.lang.String WINDOW_ID_PARAM_NAME
public static final java.lang.String DEFAULT_DISPATCH_SERVLET
public static java.lang.String INVALID_REMOTEADDR
public static final java.lang.String REQUEST_CONTEXT_NAME
public static final java.lang.String WINDOW_CONTEXT_NAME
public static final java.lang.String URL_PARAMETER_ARGNAME
public static final java.lang.String URL_PARAMETER_SPECIFIER
public static java.lang.String SESSION_INVALIDATED
public static final int PAGE_EVENT_MASK
public static final int SESSION_EVENT_MASK
public static final int PROFILE_EVENT_MASK
public static final int ENCODE_NONE
public static final int ENCODE_CONTEXT_PATH
public static final int ENCODE_IF_NOT_THERE
public static final java.lang.String DEFAULT_PARAMETER_DELIMITER
public static final java.lang.String GLOBAL_SCOPE
public static final java.lang.String SESSION_SCOPE
public static final java.lang.String WINDOW_SCOPE
public static final java.lang.String REQUEST_SCOPE
public static final java.lang.String PROTOTYPE_SCOPE
public static final java.lang.String PAGE_FRAGMENT_SUBSTITUTER_ATTRIBUTE
PageFragmentSubstituter
.public DynamoHttpServletRequest()
protected void swapRequest(javax.servlet.http.HttpServletRequest pRequest)
swapRequest
in class MutableHttpServletRequest
public void setRequest(javax.servlet.http.HttpServletRequest pRequest)
setRequest
in class MutableHttpServletRequest
public void endRequest()
public void setResponse(DynamoHttpServletResponse pResponse)
pResponse
- new value to setpublic DynamoHttpServletResponse getResponse()
public void setUserAuthenticator(UserAuthenticator pUserAuthenticator)
public UserAuthenticator getUserAuthenticator()
public void setLog(ApplicationLogging pLog)
public ApplicationLogging getLog()
public atg.servlet.minimal.WebApplicationInterface getWebApplication()
public java.lang.String getURLParameterString()
public void setParameterDelimiter(java.lang.String pParameterDelimiter)
public java.lang.String getParameterDelimiter()
public void setUseXmlParamDelimiter(java.lang.Boolean pUseXmlParamDelimiter)
public java.lang.Boolean isUseXmlParamDelimiter()
public void setScrambleKey(byte[] pScrambleKey)
public byte[] getScrambleKey()
public void setMimeTyper(MimeTyper pMimeTyper)
public MimeTyper getMimeTyper()
public void setNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pNameResolverFactory)
public atg.nucleus.MultiRootNameResolverFactory getNameResolverFactory()
public void setMultiNucleusNameResolverFactory(atg.nucleus.MultiRootNameResolverFactory pMultiNucleusNameResolverFactory)
public atg.nucleus.MultiRootNameResolverFactory getMultiNucleusNameResolverFactory()
public boolean isDelayedRequest()
public void setParameterHandler(atg.servlet.ParameterHandler pParameterHandler)
public void setExitTrackingHandler(atg.servlet.exittracking.ExitTrackingHandler pExitTrackingHandler)
public atg.servlet.exittracking.ExitTrackingHandler getExitTrackingHandler()
public HttpSessionRequest getSessionRequest()
getSession(boolean)
public HttpSessionRequest getSessionRequest(boolean pCreate)
getSession(boolean)
public void setSessionRequest(HttpSessionRequest pSessionRequest)
public void removeSessionFromRequest()
getSession(boolean)
public void setRequestScopeManager(RequestScopeManager pRequestScopeManager)
public RequestScopeManager getRequestScopeManager()
public void setWindowScopeManager(atg.nucleus.WindowScopeManager pScopeManager)
public atg.nucleus.WindowScopeManager getWindowScopeManager()
public void setRequestScope(NameContext pRequestScope)
public NameContext getRequestScope()
public boolean hasRequestScope()
public NameContext getWindowScope()
public DynamoHttpServletRequest getRequestForComparison()
public Nucleus getNucleus()
public void setNucleus(Nucleus pNucleus)
public BrowserTyper getBrowserTyper()
public void setBrowserTyper(BrowserTyper pBrowserTyper)
public boolean getGenerateRequestLocales()
A value of false for this property will turn of the creation of RequestLocale objects. No RequestLocale objects will be created for any requests. Calling DynamoHttpServletRequest.getRequestLocale() will return null if this property is set to false. You must set this value to true if you are serving content of a different language than the server runs in.
public void setGenerateRequestLocales(boolean pValue)
A value of false for this property will turn of the creation of RequestLocale objects. No RequestLocale objects will be created for any requests. Calling DynamoHttpServletRequest.getRequestLocale() will return null if this property is set to false. You must set this value to true if you are serving content of a different language than the server runs in.
public ComponentName getRequestLocalePath()
The path to the request locale component.
public void setRequestLocalePath(ComponentName pValue)
The path to the request locale component.
public atg.servlet.RequestLocale getRequestLocale()
public void setRequestLocale(atg.servlet.RequestLocale pLocale)
public void setInitialized(boolean pInitialized)
pInitialized
- true if this object is initializedpublic boolean isInitialized()
public java.lang.String getRequestURI()
getRequestURI
in interface javax.servlet.http.HttpServletRequest
getRequestURI
in class MutableHttpServletRequest
public java.lang.String getRequestURIWithQueryString()
public java.util.Enumeration getParameterNamesInStack()
public java.lang.String getQueryParameter(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getQueryParameter(java.lang.String pKey, int pIndex)
pKey
- The name of the parameterpIndex
- The index of the parameterpublic java.lang.String[] getQueryParameterValues(java.lang.String pKey)
pKey
- The name of the parameterpublic java.util.Enumeration getQueryParameterNames()
public int getQueryParameterCount(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getPostParameter(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getPostParameter(java.lang.String pKey, int pIndex)
pKey
- The name of the parameterpIndex
- The index of the parameterpublic java.lang.String[] getPostParameterValues(java.lang.String pKey)
pKey
- The name of the parameterpublic java.util.Enumeration getPostParameterNames()
public int getPostParameterCount(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getURLParameter(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getURLParameter(java.lang.String pKey, int pIndex)
pKey
- The name of the parameterpIndex
- The index of the parameterpublic java.lang.Object getObjectURLParameter(java.lang.String pKey, int pIndex)
pKey
- The name of the parameterpIndex
- The index of the parameterpublic java.lang.String[] getURLParameterValues(java.lang.String pKey)
pKey
- The name of the parameterpublic java.util.Enumeration getURLParameterNames()
public int getURLParameterCount(java.lang.String pKey)
pKey
- The name of the parameterpublic boolean tamperedURLParameters()
public boolean getEncodeServletPath()
public void setEncodeServletPath(boolean pEncode)
pEncode
- whether to encode the ServletPath into encodeUrl.public int getEncodeContextPathMode()
public void setEncodeContextPathMode(int pEncodeMode)
pEncodeMode
- how to encode the ContextPath into the URLpublic java.lang.String getCookieParameter(java.lang.String pKey)
pKey
- The name of the parameterpublic java.lang.String getCookieParameter(java.lang.String pKey, int pIndex)
pKey
- The name of the parameterpIndex
- The index of the parameterpublic java.lang.String[] getCookieParameterValues(java.lang.String pKey)
pKey
- The name of the parameterpublic java.util.Enumeration getCookieParameterNames()
public int getCookieParameterCount(java.lang.String pKey)
pKey
- The name of the parameterpublic boolean isBrowserType(java.lang.String pFeature)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getMimeType()
public void setMimeType(java.lang.String pMimeType)
public java.lang.String getWorkingDirectory()
public void setLinkEncoding(java.lang.String pLinkEncoding)
pLinkEncoding
- new value to setpublic java.lang.String getLinkEncoding()
public void addQueryParameter(java.lang.String pKey, java.lang.String pValue)
pKey
- The name of the parameterpValue
- The value of the parameterpublic void addURLParameter(java.lang.String pKey, java.lang.String pValue)
pKey
- The name of the parameterpValue
- The value of the parameterpublic void addPersistentQueryParameter(java.lang.String pKey, java.lang.String pValue)
The persistent query parameter may be removed using the removePersistentQueryParameter() method.
pKey
- The name of the parameterpValue
- The value of the parameterremovePersistentQueryParameter(String)
public void removePersistentQueryParameter(java.lang.String pKey)
pKey
- The name of the parameteraddPersistentQueryParameter(String,String)
public java.lang.String encodeURL(java.lang.String pURL)
pURL
- The URL to encodepublic java.lang.String encodeURL(java.lang.String pURL, boolean pClearParameters)
pURL
- The URL to encodepClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)public java.lang.String performExitTracking(java.lang.String pURL)
performExitTracking
in interface atg.servlet.exittracking.ExitTrackingHandler
public boolean shouldExitTrack(java.lang.String pURL)
shouldExitTrack
in interface atg.servlet.exittracking.ExitTrackingHandler
pURL
- The URL to check if it should be exit trackedpublic java.lang.String getExitTrackingParameterName()
getExitTrackingParameterName
in interface atg.servlet.exittracking.ExitTrackingHandler
public java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.public java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL, boolean pInterpretURIs)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.pInterpretURIs
- means prepend contextPath (and possibly
servletPath, if encodeServletPath is true).public java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL, boolean pInterpretURIs, boolean pDoExitTracking)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.pInterpretURIs
- means prepend contextPath (and possibly
servletPath, if encodeServletPath is true).pPrependMode
- If pInterpretURIs is true, this mode determines how
the contextPath is prepended. It can be set to ENCODE_NONE,
ENCODE_IF_NOT_THERE, and ENCODE_CONTEXT_PATH.pDoExitTracking
- if true, outline procedure is implemented so that
URLs which leave the site are encoded through an outline URL.public java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL, boolean pInterpretURIs, boolean pDoExitTracking, boolean pUseReverseMap)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.pInterpretURIs
- means prepend contextPath (and possibly
servletPath, if encodeServletPath is true).pPrependMode
- If pInterpretURIs is true, this mode determines how
the contextPath is prepended. It can be set to ENCODE_NONE,
ENCODE_IF_NOT_THERE, and ENCODE_CONTEXT_PATH.pDoExitTracking
- if true, outline procedure is implemented so that
URLs which leave the site are encoded through an outline URL.public java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL, boolean pInterpretURIs, boolean pDoExitTracking, int pPrependMode)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.pInterpretURIs
- means prepend contextPath (and possibly
servletPath, if encodeServletPath is true).pPrependMode
- If pInterpretURIs is true, this mode determines how
the contextPath is prepended. It can be set to ENCODE_NONE,
ENCODE_IF_NOT_THERE, and ENCODE_CONTEXT_PATH.pDoExitTracking
- if true, outline procedure is implemented so that
URLs which leave the site are encoded through an outline URL.pUseReverseMap
- if true, the layering context root reverse map
is used to correct the URLpublic java.lang.String encodeURL(java.lang.String pURL, boolean pEncodeParameters, boolean pClearParameters, boolean pIsImageURL, boolean pInterpretURIs, boolean pDoExitTracking, int pPrependMode, boolean pUseReverseMap)
pURL
- The URL to encodepEncodeParameters
- Flag indicating if Query and URL Parameters should
be encodedpClearParameters
- Flag indicating if the accumulated Parameters
should be cleared after this operation (only if pEncodeParameters is true)pIsImageURL
- Flag indicating if this is an ImageURL. We don't do
exit tracking or session ids on image URLs.pInterpretURIs
- means prepend contextPath (and possibly
servletPath, if encodeServletPath is true).pPrependMode
- If pInterpretURIs is true, this mode determines how
the contextPath is prepended. It can be set to ENCODE_NONE,
ENCODE_IF_NOT_THERE, and ENCODE_CONTEXT_PATH.pDoExitTracking
- if true, outline procedure is implemented so that
URLs which leave the site are encoded through an outline URL.pUseReverseMap
- if true, the layering context root reverse map
is used to correct the URLpublic java.lang.String reverseMapContextRootForLayering(java.lang.String strFinalURL)
public void setEncodeURL(boolean pEncodeURL)
public boolean getEncodeURL()
public void setURLSessionIdSpecifier(java.lang.String pURLSessionIdSpecifier)
public java.lang.String getURLSessionIdSpecifier()
public void setRestorableSessionIdFromURL(java.lang.String pRestorableSessionIdFromURL)
public java.lang.String getRestorableSessionIdFromURL()
public void setWebApplication(atg.servlet.minimal.WebApplicationInterface pWebApplication)
pWebApplication
- the WebApplicationInterface to assicate with this
request.public void setRedirectURLValidator(atg.servlet.pipeline.RedirectURLValidatorService pRedirectURLValidator)
public atg.servlet.pipeline.RedirectURLValidatorService getRedirectURLValidator()
public boolean isLoggingInfo()
isLoggingInfo
in interface atg.core.logging.Logging
isLoggingInfo
in interface ApplicationLogging
public void setLoggingInfo(boolean pLogging)
setLoggingInfo
in interface atg.core.logging.Logging
setLoggingInfo
in interface ApplicationLogging
public boolean isLoggingWarning()
isLoggingWarning
in interface atg.core.logging.Logging
isLoggingWarning
in interface ApplicationLogging
public void setLoggingWarning(boolean pLogging)
setLoggingWarning
in interface atg.core.logging.Logging
setLoggingWarning
in interface ApplicationLogging
public boolean isLoggingError()
isLoggingError
in interface atg.core.logging.Logging
isLoggingError
in interface ApplicationLogging
public void setLoggingError(boolean pLogging)
setLoggingError
in interface atg.core.logging.Logging
setLoggingError
in interface ApplicationLogging
public boolean isLoggingDebug()
isLoggingDebug
in interface atg.core.logging.Logging
isLoggingDebug
in interface ApplicationLogging
public void setLoggingDebug(boolean pLogging)
setLoggingDebug
in interface atg.core.logging.Logging
setLoggingDebug
in interface ApplicationLogging
public void logInfo(java.lang.String pMessage)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logInfo(java.lang.Throwable pThrowable)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable)
logInfo
in interface atg.core.logging.Logging
logInfo
in interface ApplicationLogging
public void logWarning(java.lang.String pMessage)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logWarning(java.lang.Throwable pThrowable)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable)
logWarning
in interface atg.core.logging.Logging
logWarning
in interface ApplicationLogging
public void logError(java.lang.String pMessage)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logError(java.lang.Throwable pThrowable)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logError(java.lang.String pMessage, java.lang.Throwable pThrowable)
logError
in interface atg.core.logging.Logging
logError
in interface ApplicationLogging
public void logDebug(java.lang.String pMessage)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void logDebug(java.lang.Throwable pThrowable)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)
logDebug
in interface atg.core.logging.Logging
logDebug
in interface ApplicationLogging
public void printRequest(java.io.PrintStream pOut)
public void pushFrame()
public void popFrame()
public int getCountOfFrames()
public void pushParameters(java.util.Dictionary pDict)
pDict
- the dictionary of parameters to addpublic void pushDefaultParameters(java.util.Dictionary pDict)
public void popDefaultParameters()
public void popParameters()
public java.util.Map getMapForCurrentFrame()
public java.util.Map getMapCopyOfCurrentFrame()
public java.util.Map getCurrentFrameWithoutNulls(boolean pCopy)
pCopy
- whether to create a copy of the map, or simply
return a wrapped version.public void setBaseDirectory(java.lang.String pBaseDir)
pBaseDir
- the new base directory.public java.lang.String getBaseDirectory()
public void setParameter(java.lang.String pName, java.lang.Object pValue)
pName
- the name of the parameter to setpValue
- the value of the new parameterpublic void setParameter(java.lang.String pName, java.lang.Object pValue, TagConverter pCvt, java.util.Properties pCvtArgs) throws javax.servlet.ServletException
pName
- the name of the parameter to setpValue
- the value of the new parameterpCvt
- tag converter used to convert String to object valuespCvtArgs
- tag converter argsjavax.servlet.ServletException
public java.lang.Object removeParameter(java.lang.String pName)
public java.lang.Object resolveGlobalName(ComponentName pName)
public java.lang.Object resolveSessionName(ComponentName pName)
public java.lang.Object resolveRequestName(ComponentName pName)
public java.lang.Object resolveName(ComponentName pName)
pName
- the nucleus component path name to resolve. This can be
either an absolute path name, or a path name relative to where the
current PathInfo of the request is.public java.lang.Object resolveName(ComponentName pName, boolean pCreate)
pName
- the nucleus component path name to resolve. This can be
either an absolute path name, or a path name relative to where the
current PathInfo of the request is.pCreate
- true if we should create the component if it does not
yet exist.public ComponentName getContextNamePath()
public java.lang.Object resolveGlobalName(java.lang.String pName)
public java.lang.Object resolveSessionName(java.lang.String pName)
public java.lang.Object resolveRequestName(java.lang.String pName)
public java.lang.Object resolveName(java.lang.String pName)
resolveName
in interface NameResolver
pName
- the nucleus component path name to resolve. This can be
either an absolute path name, or a path name relative to where the
current PathInfo of the request is.public java.lang.Object resolveName(java.lang.String pName, boolean pCreate)
pName
- the nucleus component path name to resolve. This can be
either an absolute path name, or a path name relative to where the
current PathInfo of the request is.pCreate
- true if we should create the component if it does not
yet exist.public java.lang.String getParameter(ParameterName pName)
public java.lang.Object getLocalParameter(ParameterName pName)
pName
- the name of the local parameter to get.public java.lang.Object getObjectParameter(ParameterName pName)
If the parameter name starts with a '.' character, only the top most stack of parameters is searched. If the parameter name starts with '..', one frame level up from the current frame is searched, and so on.
This routine searches the same name space as getParameter but returns its value as an Object instead of as a String.
This routine uses a ParameterName object rather than a String name.
public boolean serviceParameter(ParameterName pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean serviceParameter(ParameterName pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes, TagConverter pCvt, java.util.Properties pCvtArgs) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean serviceLocalParameter(ParameterName pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public java.lang.Object getObjectParameter(java.lang.String pName)
If the parameter name starts with a '.' character, only the top most stack of parameters is searched. If the parameter name starts with '..', one frame level up from the current frame is searched, and so on.
This routine searches the same name space as getParameter but returns its value as an Object instead of as a String.
public java.lang.String getParameter(java.lang.String pName)
getParameter
in interface javax.servlet.ServletRequest
getParameter
in class MutableHttpServletRequest
public java.lang.Object getLocalParameter(java.lang.String pName)
public java.lang.String[] getParameterValues(java.lang.String pName)
getParameterValues
in interface javax.servlet.ServletRequest
getParameterValues
in class MutableHttpServletRequest
pName
- the parameter namepublic java.util.Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
getParameterNames
in class MutableHttpServletRequest
public boolean serviceParameter(java.lang.String pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean serviceParameter(java.lang.String pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes, TagConverter pCvt, java.util.Properties pCvtArgs) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public boolean serviceLocalParameter(java.lang.String pName, javax.servlet.ServletRequest pReq, javax.servlet.ServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
public java.lang.String getRealPath(java.lang.String pPath)
MutableHttpServletRequest
getRealPath
in interface javax.servlet.ServletRequest
getRealPath
in class MutableHttpServletRequest
public void setDocRootServicePrefix(java.lang.String pDocRootServicePrefix)
public java.lang.String getDocRootServicePrefix()
public javax.servlet.http.Cookie[] getCookies()
getCookies
in interface javax.servlet.http.HttpServletRequest
getCookies
in class MutableHttpServletRequest
public javax.servlet.http.HttpSession getSession(boolean create)
Note: to ensure the session is properly maintained, the servlet developer must call this method (at least once) before any output is written to the response.
Additionally, application-writers need to be aware that newly
created sessions (that is, sessions for which
HttpSession.isNew
returns true) do not have any
application-specific state.
getSession
in interface javax.servlet.http.HttpServletRequest
getSession
in class MutableHttpServletRequest
public javax.servlet.http.HttpSession getSession()
getSession
in interface javax.servlet.http.HttpServletRequest
getSession
in class MutableHttpServletRequest
HttpSession
associated
with this requestpublic java.lang.String getRequestedSessionId()
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
getRequestedSessionId
in class MutableHttpServletRequest
isRequestedSessionIdValid()
public boolean isRequestedSessionIdValid()
getSession
method.isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdValid
in class MutableHttpServletRequest
getRequestedSessionId()
,
HttpSessionContext
,
getSession(boolean)
public boolean isRequestedSessionIdFromCookie()
getSession
method.)isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromCookie
in class MutableHttpServletRequest
getSession(boolean)
public boolean isRequestedSessionIdFromUrl()
getSession
method.)isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
isRequestedSessionIdFromUrl
in class MutableHttpServletRequest
getSession(boolean)
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String pPath)
RequestDispatcher
object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend
outside the current servlet context. If the path begins with
a "/" it is interpreted as relative to the current context root.
This method returns null
if the servlet container
cannot return a RequestDispatcher
.
The difference between this method and
ServletContext.getRequestDispatcher(java.lang.String)
is that
this method can take a relative path.
getRequestDispatcher
in interface javax.servlet.ServletRequest
getRequestDispatcher
in class MutableHttpServletRequest
pPath
- a String
specifying the pathname to the resourceRequestDispatcher
object that acts as a wrapper for
the resource at the specified path.public javax.servlet.RequestDispatcher getRequestDispatcher(javax.servlet.ServletContext pContext, java.lang.String pPath)
RequestDispatcher
object can be used to forward
a request to the resource or to include the resource in a response.
The resource can be dynamic or static.
The pathname specified may be relative, although it cannot extend
outside the given servlet context. If the path begins with
a "/" it is interpreted as relative to the given context root.
This method returns null
if the servlet container
cannot return a RequestDispatcher
.
pPath
- a String
specifying the pathname to the resourcepContext
- a ServletContext
that the given path is
relative to.RequestDispatcher
object that acts as a wrapper for
the resource at the specified path.public void setEventFlags(int pEventFlags)
public int getEventFlags()
public void setDisableExitTracking(boolean pDisableExitTracking)
public boolean getDisableExitTracking()
public void setupLoopbackTemplateEmailRequest()
public void setInTemplatePage(boolean pInTemplatePage)
pInTemplatePage
- new value to setpublic boolean isInTemplatePage()
public void setFormEventsSent(boolean pFormEventsSent)
pFormEventsSent
- new value to setpublic boolean getFormEventsSent()
public void setRequestURIHasQueryString(boolean pRequestURIHasQueryString)
public javax.servlet.ServletRequestWrapper getWrapper()
public void setWrapper(javax.servlet.ServletRequestWrapper pWrapper)
public boolean isUserInRole(java.lang.String pRole)
isUserInRole
in interface javax.servlet.http.HttpServletRequest
isUserInRole
in class MutableHttpServletRequest
pRole
- the name of the role to test forpublic java.security.Principal getUserPrincipal()
Overrides getUserPrincipal in MutableHttpServletRequest. This version attempts to use the UserAuthenticator property of this request if it has been set. If UserAuthenticator has not been set then the super class method is called instead.
Returns ajava.security.Principal
object containing
the name of the current authenticated user. If the user has not been
authenticated, the method returns null
.getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
getUserPrincipal
in class MutableHttpServletRequest
java.security.Principal
containing
the name of the user making this request; null
if
the user has not been authenticatedpublic void setDynamoPipeline(boolean pDynamoPipeline)
pDynamoPipeline
- new value to setpublic boolean isDynamoPipeline()
public void setAfterGetsClaimed(boolean pAfterGetsClaimed)
pAfterGetsClaimed
- new value to setpublic boolean isAfterGetsClaimed()
public atg.nucleus.ResolveNameHelper getResolveNameHelper()
public void setResolveNameHelper(atg.nucleus.ResolveNameHelper pResolveNameHelper)
public atg.nucleus.ResolveNameHelper getMultiNucleusResolveNameHelper()
public static java.lang.Object getNullParameterObject()
public java.util.Map getParamMapForTopFrame()
public NameContext getSessionNameContext()
public long getSessionConfirmationNumber()