RestHttpServletRequestWrapper (ATG Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

atg.servlet
Class RestHttpServletRequestWrapper

java.lang.Object
  atg.servlet.MutableHttpServletRequest
      atg.servlet.DynamoHttpServletRequest
          atg.servlet.RestHttpServletRequestWrapper

All Implemented Interfaces:: NameResolver, ApplicationLogging, atg.servlet.exittracking.ExitTrackingHandler, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class RestHttpServletRequestWrapper
extends DynamoHttpServletRequest
extends DynamoHttpServletRequest

This class wraps the dynamo request and is used when handling rest requests for form submits.

Field Summary
`static java.lang.String`	`CLASS_VERSION` Class version string

Fields inherited from class atg.servlet.DynamoHttpServletRequest
ATTRIBUTE_NAME, CERTIFICATES_ATTRIBUTE, CIPHER_SUITE_ATTR, CURRENT_SERVLET_NAME_ATTRIBUTE, DEFAULT_DISPATCH_SERVLET, DEFAULT_PARAMETER_DELIMITER, ENCODE_CONTEXT_PATH, ENCODE_IF_NOT_THERE, ENCODE_NONE, ERROR_EXCEPTION_ATTRIBUTE, ERROR_EXCEPTION_TYPE_ATTRIBUTE, ERROR_MESSAGE_ATTRIBUTE, ERROR_REQUEST_URI_ATTRIBUTE, ERROR_SERVLET_NAME_ATTRIBUTE, ERROR_STATUS_ATTRIBUTE, FORM_EVENTS_SENT_ATTRIBUTE, GLOBAL_SCOPE, INCLUDE_CONTEXT_PATH_ATTRIBUTE, INCLUDE_PATH_INFO_ATTRIBUTE, INCLUDE_PATH_TRANSLATED_ATTRIBUTE, INCLUDE_QUERY_STRING_ATTRIBUTE, INCLUDE_REQUEST_URI_ATTRIBUTE, INCLUDE_SERVLET_PATH_ATTRIBUTE, INVALID_REMOTEADDR, KEY_SIZE_ATTR, LAYERING_REMAP_ATTRIBUTE_NAME, OBJECT_PARAMETER_ATTRIBUTE_NAME, PAGE_EVENT_MASK, PAGE_FRAGMENT_SUBSTITUTER_ATTRIBUTE, PATH_TRANSLATOR, PROFILE_EVENT_MASK, PROTOTYPE_SCOPE, REQUEST_CONTEXT_NAME, REQUEST_SCOPE, SESSION_EVENT_MASK, SESSION_INVALIDATED, SESSION_SCOPE, URL_PARAMETER_ARGNAME, URL_PARAMETER_SPECIFIER, WINDOW_CONTEXT_NAME, WINDOW_ID_PARAM_NAME, WINDOW_SCOPE

Fields inherited from class atg.servlet.DynamoHttpServletRequest

ATTRIBUTE_NAME, CERTIFICATES_ATTRIBUTE, CIPHER_SUITE_ATTR, CURRENT_SERVLET_NAME_ATTRIBUTE, DEFAULT_DISPATCH_SERVLET, DEFAULT_PARAMETER_DELIMITER, ENCODE_CONTEXT_PATH, ENCODE_IF_NOT_THERE, ENCODE_NONE, ERROR_EXCEPTION_ATTRIBUTE, ERROR_EXCEPTION_TYPE_ATTRIBUTE, ERROR_MESSAGE_ATTRIBUTE, ERROR_REQUEST_URI_ATTRIBUTE, ERROR_SERVLET_NAME_ATTRIBUTE, ERROR_STATUS_ATTRIBUTE, FORM_EVENTS_SENT_ATTRIBUTE, GLOBAL_SCOPE, INCLUDE_CONTEXT_PATH_ATTRIBUTE, INCLUDE_PATH_INFO_ATTRIBUTE, INCLUDE_PATH_TRANSLATED_ATTRIBUTE, INCLUDE_QUERY_STRING_ATTRIBUTE, INCLUDE_REQUEST_URI_ATTRIBUTE, INCLUDE_SERVLET_PATH_ATTRIBUTE, INVALID_REMOTEADDR, KEY_SIZE_ATTR, LAYERING_REMAP_ATTRIBUTE_NAME, OBJECT_PARAMETER_ATTRIBUTE_NAME, PAGE_EVENT_MASK, PAGE_FRAGMENT_SUBSTITUTER_ATTRIBUTE, PATH_TRANSLATOR, PROFILE_EVENT_MASK, PROTOTYPE_SCOPE, REQUEST_CONTEXT_NAME, REQUEST_SCOPE, SESSION_EVENT_MASK, SESSION_INVALIDATED, SESSION_SCOPE, URL_PARAMETER_ARGNAME, URL_PARAMETER_SPECIFIER, WINDOW_CONTEXT_NAME, WINDOW_ID_PARAM_NAME, WINDOW_SCOPE

Fields inherited from interface atg.nucleus.logging.ApplicationLogging
`DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS`

Fields inherited from interface javax.servlet.http.HttpServletRequest
`BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH`

Constructor Summary
`RestHttpServletRequestWrapper(DynamoHttpServletRequest pRequest, BeanURI pParsedURI)` Constructor

Method Summary
`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, int pPrependMode)` Encodes a URL with all the accumulated Parameters.
`void`	`endRequest()` Clean up after the request once it has finished.
`boolean`	`equals(java.lang.Object pObj)`
`java.lang.Object`	`getAttribute(java.lang.String pP0)` Wraps the call to getAttribute
`java.lang.Object`	`getAttribute(java.lang.String pP0, boolean pCreate)` Wraps the call to getAttribute
`java.util.Enumeration`	`getAttributeNames()` Returns an `Enumeration` containing the names of the attributes available to this request.
`java.lang.String`	`getAuthType()` Wraps the call to getAuthType
`java.lang.String`	`getBaseDirectory()` Returns the current base directory or null if it is not set
`BrowserTyper`	`getBrowserTyper()` Returns the BrowserTyper
`java.lang.String`	`getCharacterEncoding()` Returns the character set encoding for the input of this request.
`int`	`getContentLength()` Wraps the call to getContentLength
`java.lang.String`	`getContentType()` Wraps the call to getContentType
`java.lang.String`	`getContextPath()` Returns the portion of the request URI that indicates the context of the request.
`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.
`long`	`getDateHeader(java.lang.String pP0)` Wraps the call to getDateHeader
`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`	`getHeader(java.lang.String pP0)` Wraps the call to getHeader
`java.util.Enumeration`	`getHeaderNames()` Wraps the call to getHeaderNames
`java.util.Enumeration`	`getHeaders(java.lang.String pName)` Returns all the values of the specified request header as an `Enumeration` of `String` objects.
`javax.servlet.ServletInputStream`	`getInputStream()` Wraps the call to getInputStream
`int`	`getIntHeader(java.lang.String pP0)` Wraps the call to getIntHeader
`java.lang.String`	`getLinkEncoding()`
`java.lang.String`	`getLocalAddr()`
`java.util.Locale`	`getLocale()` Returns the preferred `Locale` that the client will accept content in, based purely on the Accept-Language header.
`java.util.Enumeration`	`getLocales()` Returns an `Enumeration` of `Locale` objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client.
`java.lang.String`	`getLocalName()`
`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)`
`int`	`getLocalPort()`
`java.util.Map`	`getMapForCurrentFrame()` Return a Map that represents the current frame of the param stack.
`java.lang.String`	`getMethod()` Wraps the call to getMethod
`java.lang.String`	`getMimeType()` Returns the mimetype of this particular request file
`MimeTyper`	`getMimeTyper()` Returns the MimeTyper property
`Nucleus`	`getNucleus()` Returns the Nucleus
`java.lang.Object`	`getObjectParameter(ParameterName pName)` Returns the parameter with the given name.
`java.lang.Object`	`getObjectParameter(java.lang.String pName)` Intercepts the getObjectParameter call to the underlying request and substitutes parameters from the REST request.
`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)` Intercepts the getParameter call to the underlying request and substitutes parameters from the REST request.
`java.lang.String`	`getParameterDelimiter()` Returns the parameterDelimiter property
`java.util.Map`	`getParameterMap()` Returns a java.util.Map of the parameters of this request.
`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.
`BeanURI`	`getParsedURI()` The ParsedURI for this request
`java.lang.String`	`getPathInfo()` Wraps the call to getPathInfo
`java.lang.String`	`getPathTranslated()` Wraps the call to getPathTranslated
`java.lang.Object`	`getPermanentAttribute(AttributeFactory pKey)` This returns a permanent attribute value corresponding to the given key.
`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`	`getProtocol()` Wraps the call to getProtocol
`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`	`getQueryString()` Wraps the call to getQueryString
`java.io.BufferedReader`	`getReader()` Returns an input stream for reading the request body.
`java.lang.String`	`getRealPath(java.lang.String pPath)` Wraps the call to getRealPath
`java.lang.String`	`getRemoteAddr()` Wraps the call to getRemoteAddr
`java.lang.String`	`getRemoteHost()` Wraps the call to getRemoteHost
`int`	`getRemotePort()`
`java.lang.String`	`getRemoteUser()` Wraps the call to getRemoteUser
`DynamoHttpServletRequest`	`getRequest()` returns the wrapped request
`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)` Wrap request dispatcher to allow forward calls to be intercepted.
`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.
`java.lang.StringBuffer`	`getRequestURL()` Reconstructs the URL the client used to make the request.
`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.
`java.lang.String`	`getScheme()` Wraps the call to getScheme
`byte[]`	`getScrambleKey()` Returns the Scramble Key property
`java.lang.String`	`getServerName()` Wraps the call to getServerName
`int`	`getServerPort()` Wraps the call to getServerPort
`java.lang.String`	`getServletPath()` Wraps the call to getServletPath
`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 pCreate)` 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).
`atg.servlet.WebPools`	`getWebPools()` Return the WebPools object associated with this request.
`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.
`int`	`hashCode()`
`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`	`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`	`isSecure()` Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS
`boolean`	`isUserInRole(java.lang.String pRole)` Overrides isUserInRole in MutableHttpServletRequest.
`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.
`void`	`removeAttribute(java.lang.String pName)` Removes an attribute from this request.
`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.
`java.lang.Object`	`resolveGlobalName(java.lang.String pName)` Deprecated.
`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.
`java.lang.Object`	`resolveRequestName(java.lang.String pName)` Deprecated.
`java.lang.Object`	`resolveSessionName(ComponentName pName)` Deprecated.
`java.lang.Object`	`resolveSessionName(java.lang.String pName)` Deprecated.
`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`	`setAttribute(java.lang.String pName, java.lang.Object pValue)` Sets an attribute with the given name and value.
`void`	`setAttributeFactory(java.lang.String pName, AttributeFactory pFactory)` Sets an attribute factory that will only be called if someone asks for the specified attribute.
`void`	`setAuthType(java.lang.String pAuthType)` Sets the AuthType
`void`	`setBaseDirectory(java.lang.String pBaseDir)` Sets the base directory.
`void`	`setBrowserTyper(BrowserTyper pBrowserTyper)` Sets the BrowserTyper
`void`	`setCharacterEncoding(java.lang.String pEncoding)` Overrides the name of the character encoding used in the body of this request.
`void`	`setContentLength(int pContentLength)` Sets the ContentLength
`void`	`setContentType(java.lang.String pContentType)` Sets the ContentType
`void`	`setContextPath(java.lang.String pContextPath)` Sets the portion of the request URI that indicates the context of the request.
`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`	`setInputStream(javax.servlet.ServletInputStream pInputStream)` Sets the InputStream
`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`	`setMethod(java.lang.String pMethod)` Sets the Method
`void`	`setMimeType(java.lang.String pMimeType)` Sets the mime type in the request.
`void`	`setMimeTyper(MimeTyper pMimeTyper)` Sets the MimeTyper property
`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`	`setParsedURI(BeanURI pParsedURI)` Sets the ParsedURI for this request
`void`	`setPathInfo(java.lang.String pPathInfo)` Sets the PathInfo
`void`	`setPathTranslated(java.lang.String pPathTranslated)` Sets the PathTranslated
`void`	`setProtocol(java.lang.String pProtocol)` Sets the Protocol
`void`	`setQueryString(java.lang.String pQueryString)` Sets the QueryString
`void`	`setRemoteAddr(java.lang.String pRemoteAddr)` Sets the RemoteAddr
`void`	`setRemoteHost(java.lang.String pRemoteHost)` Sets the RemoteHost
`void`	`setRemoteUser(java.lang.String pRemoteUser)` Sets the RemoteUser
`void`	`setRequest(DynamoHttpServletRequest pRequest)` Sets the wrapped request
`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`	`setRequestURI(java.lang.String pRequestURI)` Sets the RequestURI
`void`	`setRequestURIHasQueryString(boolean pRequestURIHasQueryString)` The servlet specification requires that the requestURI not contain query args.
`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`	`setScheme(java.lang.String pScheme)` Sets the Scheme
`void`	`setScrambleKey(byte[] pScrambleKey)` Sets the Scramble Key property
`void`	`setServerName(java.lang.String pServerName)` Sets the ServerName
`void`	`setServerPort(int pServerPort)` Sets the ServerPort
`void`	`setServletPath(java.lang.String pServletPath)` Sets the ServletPath
`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`	`setWebApplication(atg.servlet.minimal.WebApplicationInterface pWebApplication)` Set the J2EE WebApplicationInterface associated with this request.
`void`	`setWebPools(atg.servlet.WebPools pWebPools)` Set the WebPools object 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
`boolean`	`tamperedURLParameters()` Returns true if the special Dynamo URL parameters could not be properly decoded.
`java.lang.String`	`toString()` Return the string representation.

Methods inherited from class atg.servlet.DynamoHttpServletRequest
`getContextNamePath, getCountOfFrames, getLog, getMapCopyOfCurrentFrame, getMultiNucleusNameResolverFactory, getMultiNucleusResolveNameHelper, getNameResolverFactory, getNullParameterObject, getRedirectURLValidator, getResolveNameHelper, reverseMapContextRootForLayering, setMultiNucleusNameResolverFactory, setNameResolverFactory, setRedirectURLValidator, setResolveNameHelper, swapRequest`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

RestHttpServletRequestWrapper

public RestHttpServletRequestWrapper(DynamoHttpServletRequest pRequest,
                                     BeanURI pParsedURI)

Constructor

Method Detail

getRequest

public DynamoHttpServletRequest getRequest()

returns the wrapped request

Overrides:: getRequest in class MutableHttpServletRequest

Returns:: the wrapped request

setRequest

public void setRequest(DynamoHttpServletRequest pRequest)

Sets the wrapped request

Parameters:: pRequest - the request to set

getParsedURI

public BeanURI getParsedURI()

The ParsedURI for this request

Returns:: the value of parsedURI

setParsedURI

public void setParsedURI(BeanURI pParsedURI)

Sets the ParsedURI for this request

Parameters:: pParsedURI - the parsedURI to set

addPersistentQueryParameter

public void addPersistentQueryParameter(java.lang.String pKey,
                                        java.lang.String pValue)

Description copied from class: DynamoHttpServletRequest

Adds a persistent query parameter which will be encoded in all subsequent calls to encodeURL. This method supplies a key/value pair that will be encoded into all subsequent URLs that are generated by calling the request's encodeURL() method family. This is extremely useful for propagating query args from request to request, particularly query args that are interpreted by pipeline servlets. A servlet that is sensitive to query arg "foo" might call addPersistentQueryParameter() on its request before calling passRequest() so that all URLs encoded later will preserve the value of "foo" that was picked up by the servlet.

The persistent query parameter may be removed using the removePersistentQueryParameter() method.

Overrides:: addPersistentQueryParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pValue -
See Also:: DynamoHttpServletRequest.addPersistentQueryParameter(java.lang.String, java.lang.String)

addQueryParameter

public void addQueryParameter(java.lang.String pKey,
                              java.lang.String pValue)

Description copied from class: DynamoHttpServletRequest

Adds a query parameter which will be encoded in the next call to encodeURL

Overrides:: addQueryParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pValue -
See Also:: DynamoHttpServletRequest.addQueryParameter(java.lang.String, java.lang.String)

addURLParameter

public void addURLParameter(java.lang.String pKey,
                            java.lang.String pValue)

Description copied from class: DynamoHttpServletRequest

Adds a URL parameter which will be encoded in the next call to encodeURL

Overrides:: addURLParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pValue -
See Also:: DynamoHttpServletRequest.addURLParameter(java.lang.String, java.lang.String)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL,
                                  boolean pEncodeParameters,
                                  boolean pClearParameters,
                                  boolean pIsImageURL,
                                  boolean pInterpretURIs,
                                  boolean pDoExitTracking,
                                  int pPrependMode)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated Parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an outlink procedure, if the Outlink URL property is set.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -; pEncodeParameters -; pClearParameters -; pIsImageURL -; pInterpretURIs -; pDoExitTracking -; pPrependMode -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String, boolean, boolean, boolean, boolean, boolean, int)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL,
                                  boolean pEncodeParameters,
                                  boolean pClearParameters,
                                  boolean pIsImageURL,
                                  boolean pInterpretURIs,
                                  boolean pDoExitTracking)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated Parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an outlink procedure, if the Outlink URL property is set.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -; pEncodeParameters -; pClearParameters -; pIsImageURL -; pInterpretURIs -; pDoExitTracking -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String, boolean, boolean, boolean, boolean, boolean)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL,
                                  boolean pEncodeParameters,
                                  boolean pClearParameters,
                                  boolean pIsImageURL,
                                  boolean pInterpretURIs)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated Parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an outlink procedure, if the Outlink URL property is set.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -; pEncodeParameters -; pClearParameters -; pIsImageURL -; pInterpretURIs -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String, boolean, boolean, boolean, boolean)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL,
                                  boolean pEncodeParameters,
                                  boolean pClearParameters,
                                  boolean pIsImageURL)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated Parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an outlink procedure, if the Outlink URL property is set.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -; pEncodeParameters -; pClearParameters -; pIsImageURL -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String, boolean, boolean, boolean)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL,
                                  boolean pClearParameters)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated Parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an exit tracking procedure, if the exitTrackingHandler property is set.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -; pClearParameters -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String, boolean)

encodeURL

public java.lang.String encodeURL(java.lang.String pURL)

Description copied from class: DynamoHttpServletRequest

Encodes a URL with all the accumulated parameters. Parameters are only encoded for relative URLs. Absolute URLs are sent through an exit tracking procedure, if the exitTrackingHandler property is set. Clears accumulated parameters after use.

Overrides:: encodeURL in class DynamoHttpServletRequest

Parameters:: pURL -
Returns:
See Also:: DynamoHttpServletRequest.encodeURL(java.lang.String)

endRequest

public void endRequest()

Description copied from class: DynamoHttpServletRequest

Clean up after the request once it has finished.

Overrides:: endRequest in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.endRequest()

equals

public boolean equals(java.lang.Object pObj)

Overrides:: equals in class java.lang.Object

Parameters:: pObj -
Returns:
See Also:: Object.equals(java.lang.Object)

getAttribute

public java.lang.Object getAttribute(java.lang.String pP0,
                                     boolean pCreate)

Description copied from class: MutableHttpServletRequest

Wraps the call to getAttribute

Overrides:: getAttribute in class MutableHttpServletRequest

Parameters:: pP0 -; pCreate -
Returns:
See Also:: MutableHttpServletRequest.getAttribute(java.lang.String, boolean)

getAttribute

public java.lang.Object getAttribute(java.lang.String pP0)

Description copied from class: MutableHttpServletRequest

Wraps the call to getAttribute

Specified by:: getAttribute in interface javax.servlet.ServletRequest
Overrides:: getAttribute in class MutableHttpServletRequest

Parameters:: pP0 -
Returns:
See Also:: MutableHttpServletRequest.getAttribute(java.lang.String)

getAttributeNames

public java.util.Enumeration getAttributeNames()

Description copied from class: MutableHttpServletRequest

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Specified by:: getAttributeNames in interface javax.servlet.ServletRequest
Overrides:: getAttributeNames in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getAttributeNames()

getAuthType

public java.lang.String getAuthType()

Description copied from class: MutableHttpServletRequest

Wraps the call to getAuthType

Specified by:: getAuthType in interface javax.servlet.http.HttpServletRequest
Overrides:: getAuthType in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getAuthType()

getBaseDirectory

public java.lang.String getBaseDirectory()

Description copied from class: DynamoHttpServletRequest

Returns the current base directory or null if it is not set

Overrides:: getBaseDirectory in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getBaseDirectory()

getBrowserTyper

public BrowserTyper getBrowserTyper()

Description copied from class: DynamoHttpServletRequest

Returns the BrowserTyper

Overrides:: getBrowserTyper in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getBrowserTyper()

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Description copied from class: MutableHttpServletRequest

Returns the character set encoding for the input of this request.

Specified by:: getCharacterEncoding in interface javax.servlet.ServletRequest
Overrides:: getCharacterEncoding in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getCharacterEncoding()

getContentLength

public int getContentLength()

Description copied from class: MutableHttpServletRequest

Wraps the call to getContentLength

Specified by:: getContentLength in interface javax.servlet.ServletRequest
Overrides:: getContentLength in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getContentLength()

getContentType

public java.lang.String getContentType()

Description copied from class: MutableHttpServletRequest

Wraps the call to getContentType

Specified by:: getContentType in interface javax.servlet.ServletRequest
Overrides:: getContentType in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getContentType()

getContextPath

public java.lang.String getContextPath()

Description copied from class: MutableHttpServletRequest

Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "".

Specified by:: getContextPath in interface javax.servlet.http.HttpServletRequest
Overrides:: getContextPath in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getContextPath()

getCookieParameter

public java.lang.String getCookieParameter(java.lang.String pKey,
                                           int pIndex)

Description copied from class: DynamoHttpServletRequest

Returns the nth Cookie parameter matching the given key and index. Returns null if the key is not found or if there were not enough parameters with the same key.
Causes the cookies headers to be parsed and cached if they weren't already.

Overrides:: getCookieParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pIndex -
Returns:
See Also:: DynamoHttpServletRequest.getCookieParameter(java.lang.String, int)

getCookieParameter

public java.lang.String getCookieParameter(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getCookieParameter in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getCookieParameter(java.lang.String)

getCookieParameterCount

public int getCookieParameterCount(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getCookieParameterCount in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getCookieParameterCount(java.lang.String)

getCookieParameterNames

public java.util.Enumeration getCookieParameterNames()

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getCookieParameterNames in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getCookieParameterNames()

getCookieParameterValues

public java.lang.String[] getCookieParameterValues(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getCookieParameterValues in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getCookieParameterValues(java.lang.String)

getCookies

public javax.servlet.http.Cookie[] getCookies()

Description copied from class: DynamoHttpServletRequest

Gets the array of cookies found in this request.

Specified by:: getCookies in interface javax.servlet.http.HttpServletRequest
Overrides:: getCookies in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getCookies()

getDateHeader

public long getDateHeader(java.lang.String pP0)

Description copied from class: MutableHttpServletRequest

Wraps the call to getDateHeader

Specified by:: getDateHeader in interface javax.servlet.http.HttpServletRequest
Overrides:: getDateHeader in class MutableHttpServletRequest

Parameters:: pP0 -
Returns:
See Also:: MutableHttpServletRequest.getDateHeader(java.lang.String)

getDisableExitTracking

public boolean getDisableExitTracking()

Overrides:: getDisableExitTracking in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getDisableExitTracking()

getDocRootServicePrefix

public java.lang.String getDocRootServicePrefix()

Overrides:: getDocRootServicePrefix in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getDocRootServicePrefix()

getEncodeContextPathMode

public int getEncodeContextPathMode()

Description copied from class: DynamoHttpServletRequest

Returns the EncodeContextPathMode property. This determines how the ContextPath is encoded into URLs encoded with the simple form of the encodeURL method (all of the versions except for the one which takes an explicit version of the EncodeContextPathMode parameter).

Overrides:: getEncodeContextPathMode in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getEncodeContextPathMode()

getEncodeServletPath

public boolean getEncodeServletPath()

Description copied from class: DynamoHttpServletRequest

Returns the EncodeServletPath property. This determines whether or not the ServletPath is encoded into URLs encoded with the encodeURL method that start with '/'.

Overrides:: getEncodeServletPath in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getEncodeServletPath()

getEncodeURL

public boolean getEncodeURL()

Description copied from class: DynamoHttpServletRequest

Returns the flag that indicates whether or not this request is currently encoding URLs

Overrides:: getEncodeURL in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getEncodeURL()

getEventFlags

public int getEventFlags()

Overrides:: getEventFlags in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getEventFlags()

getExitTrackingHandler

public atg.servlet.exittracking.ExitTrackingHandler getExitTrackingHandler()

Description copied from class: DynamoHttpServletRequest

Returns the exit tracking handler

Overrides:: getExitTrackingHandler in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getExitTrackingHandler()

getExitTrackingParameterName

public java.lang.String getExitTrackingParameterName()

Description copied from class: DynamoHttpServletRequest

Returns the parameter name which holds the URL to redirect to as part of the exit tracking process. If exit tracking is disabled, this returns null.

Specified by:: getExitTrackingParameterName in interface atg.servlet.exittracking.ExitTrackingHandler
Overrides:: getExitTrackingParameterName in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getExitTrackingParameterName()

getFormEventsSent

public boolean getFormEventsSent()

Overrides:: getFormEventsSent in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getFormEventsSent()

getGenerateRequestLocales

public boolean getGenerateRequestLocales()

Description copied from class: DynamoHttpServletRequest

This value gets set by the HeadPipelineServlet when the request is initially created.

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.

Overrides:: getGenerateRequestLocales in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getGenerateRequestLocales()

getHeader

public java.lang.String getHeader(java.lang.String pP0)

Description copied from class: MutableHttpServletRequest

Wraps the call to getHeader

Specified by:: getHeader in interface javax.servlet.http.HttpServletRequest
Overrides:: getHeader in class MutableHttpServletRequest

Parameters:: pP0 -
Returns:
See Also:: MutableHttpServletRequest.getHeader(java.lang.String)

getHeaderNames

public java.util.Enumeration getHeaderNames()

Description copied from class: MutableHttpServletRequest

Wraps the call to getHeaderNames

Specified by:: getHeaderNames in interface javax.servlet.http.HttpServletRequest
Overrides:: getHeaderNames in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getHeaderNames()

getHeaders

public java.util.Enumeration getHeaders(java.lang.String pName)

Description copied from class: MutableHttpServletRequest

Returns all the values of the specified request header as an Enumeration of String objects. Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty Enumeration. The header name is case insensitive. You can use this method with any request header.

Specified by:: getHeaders in interface javax.servlet.http.HttpServletRequest
Overrides:: getHeaders in class MutableHttpServletRequest

Parameters:: pName -
Returns:
See Also:: MutableHttpServletRequest.getHeaders(java.lang.String)

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Description copied from class: MutableHttpServletRequest

Wraps the call to getInputStream

Specified by:: getInputStream in interface javax.servlet.ServletRequest
Overrides:: getInputStream in class MutableHttpServletRequest

Returns:
Throws:: java.io.IOException
See Also:: MutableHttpServletRequest.getInputStream()

getIntHeader

public int getIntHeader(java.lang.String pP0)

Description copied from class: MutableHttpServletRequest

Wraps the call to getIntHeader

Specified by:: getIntHeader in interface javax.servlet.http.HttpServletRequest
Overrides:: getIntHeader in class MutableHttpServletRequest

Parameters:: pP0 -
Returns:
See Also:: MutableHttpServletRequest.getIntHeader(java.lang.String)

getLinkEncoding

public java.lang.String getLinkEncoding()

Overrides:: getLinkEncoding in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getLinkEncoding()

getLocalAddr

public java.lang.String getLocalAddr()

Specified by:: getLocalAddr in interface javax.servlet.ServletRequest
Overrides:: getLocalAddr in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getLocalAddr()

getLocale

public java.util.Locale getLocale()

Description copied from class: MutableHttpServletRequest

Returns the preferred Locale that the client will accept content in, based purely on the Accept-Language header.

Specified by:: getLocale in interface javax.servlet.ServletRequest
Overrides:: getLocale in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getLocale()

getLocales

public java.util.Enumeration getLocales()

Description copied from class: MutableHttpServletRequest

Returns an Enumeration of Locale objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client.

Specified by:: getLocales in interface javax.servlet.ServletRequest
Overrides:: getLocales in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getLocales()

getLocalName

public java.lang.String getLocalName()

Specified by:: getLocalName in interface javax.servlet.ServletRequest
Overrides:: getLocalName in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getLocalName()

getLocalParameter

public java.lang.Object getLocalParameter(ParameterName pName)

Description copied from class: DynamoHttpServletRequest

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).

Overrides:: getLocalParameter in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.getLocalParameter(atg.nucleus.naming.ParameterName)

getLocalParameter

public java.lang.Object getLocalParameter(java.lang.String pName)

Overrides:: getLocalParameter in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.getLocalParameter(java.lang.String)

getLocalPort

public int getLocalPort()

Specified by:: getLocalPort in interface javax.servlet.ServletRequest
Overrides:: getLocalPort in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getLocalPort()

getMapForCurrentFrame

public java.util.Map getMapForCurrentFrame()

Description copied from class: DynamoHttpServletRequest

Return a Map that represents the current frame of the param stack.

Overrides:: getMapForCurrentFrame in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getMapForCurrentFrame()

getMethod

public java.lang.String getMethod()

Description copied from class: MutableHttpServletRequest

Wraps the call to getMethod

Specified by:: getMethod in interface javax.servlet.http.HttpServletRequest
Overrides:: getMethod in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getMethod()

getMimeType

public java.lang.String getMimeType()

Description copied from class: DynamoHttpServletRequest

Returns the mimetype of this particular request file

Overrides:: getMimeType in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getMimeType()

getMimeTyper

public MimeTyper getMimeTyper()

Description copied from class: DynamoHttpServletRequest

Returns the MimeTyper property

Overrides:: getMimeTyper in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getMimeTyper()

getNucleus

public Nucleus getNucleus()

Description copied from class: DynamoHttpServletRequest

Returns the Nucleus

Overrides:: getNucleus in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getNucleus()

getObjectParameter

public java.lang.Object getObjectParameter(ParameterName pName)

Description copied from class: DynamoHttpServletRequest

Returns the parameter with the given name. If the name is of the form "name1.name2", introspection is used to find a name2 property of the object found by name1 and return that value.

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.

Overrides:: getObjectParameter in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.getObjectParameter(atg.nucleus.naming.ParameterName)

getObjectParameter

public java.lang.Object getObjectParameter(java.lang.String pName)

Intercepts the getObjectParameter call to the underlying request and substitutes parameters from the REST request. if the property does not exist as a REST parameter, the call is forwarded to the wrapped request.

Overrides:: getObjectParameter in class DynamoHttpServletRequest

Parameters:: pName - the parameter name
Returns:: the value of the property
See Also:: DynamoHttpServletRequest.getObjectParameter(java.lang.String)

getObjectURLParameter

public java.lang.Object getObjectURLParameter(java.lang.String pKey,
                                              int pIndex)

Description copied from class: DynamoHttpServletRequest

Returns the nth URL parameter matching the given key and index as an object. Returns null if the key is not found or if there were not enough parameters with the same key.
Causes the URL String to parsed and cached if it wasn't already.

Overrides:: getObjectURLParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pIndex -
Returns:
See Also:: DynamoHttpServletRequest.getObjectURLParameter(java.lang.String, int)

getParameter

public java.lang.String getParameter(ParameterName pName)

Description copied from class: DynamoHttpServletRequest

Returns a parameter of the request given the specified name. This request maintains a stack of dictionaries that are searched before the parameters in the request are searched

Overrides:: getParameter in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.getParameter(atg.nucleus.naming.ParameterName)

getParameter

public java.lang.String getParameter(java.lang.String pName)

Intercepts the getParameter call to the underlying request and substitutes parameters from the REST request. if the property does not exist as a REST parameter, the call is forwarded to the wrapped request.

Specified by:: getParameter in interface javax.servlet.ServletRequest
Overrides:: getParameter in class DynamoHttpServletRequest

Parameters:: pName - the parameter name
Returns:: the string value of the property
See Also:: DynamoHttpServletRequest.getParameter(java.lang.String)

getParameterDelimiter

public java.lang.String getParameterDelimiter()

Description copied from class: DynamoHttpServletRequest

Returns the parameterDelimiter property

Overrides:: getParameterDelimiter in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getParameterDelimiter()

getParameterMap

public java.util.Map getParameterMap()

Description copied from class: MutableHttpServletRequest

Returns a java.util.Map of the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.

Specified by:: getParameterMap in interface javax.servlet.ServletRequest
Overrides:: getParameterMap in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getParameterMap()

getParameterNames

public java.util.Enumeration getParameterNames()

Description copied from class: DynamoHttpServletRequest

Returns an enumeration of strings representing the parameter names for this request.

Specified by:: getParameterNames in interface javax.servlet.ServletRequest
Overrides:: getParameterNames in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getParameterNames()

getParameterNamesInStack

public java.util.Enumeration getParameterNamesInStack()

Description copied from class: DynamoHttpServletRequest

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. the list of names (keys) contained in the set of dictionaries found in the mParameterStack.

Overrides:: getParameterNamesInStack in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getParameterNamesInStack()

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String pName)

Description copied from class: DynamoHttpServletRequest

Returns the values of the specified parameter for the request as an array of strings, or null if the named parameter does not exist. For example, in an HTTP servlet this method would return the values of the specified query string or posted form as an array of strings.

Specified by:: getParameterValues in interface javax.servlet.ServletRequest
Overrides:: getParameterValues in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.getParameterValues(java.lang.String)

getParamMapForTopFrame

public java.util.Map getParamMapForTopFrame()

Description copied from class: DynamoHttpServletRequest

Return a Map representing the parameters in the current frame of the droplet parameter stack. This is typically all the local parameters for the current droplet.

Overrides:: getParamMapForTopFrame in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getParamMapForTopFrame()

getPathInfo

public java.lang.String getPathInfo()

Description copied from class: MutableHttpServletRequest

Wraps the call to getPathInfo

Specified by:: getPathInfo in interface javax.servlet.http.HttpServletRequest
Overrides:: getPathInfo in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getPathInfo()

getPathTranslated

public java.lang.String getPathTranslated()

Description copied from class: MutableHttpServletRequest

Wraps the call to getPathTranslated

Specified by:: getPathTranslated in interface javax.servlet.http.HttpServletRequest
Overrides:: getPathTranslated in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getPathTranslated()

getPermanentAttribute

public java.lang.Object getPermanentAttribute(AttributeFactory pKey)

Description copied from class: MutableHttpServletRequest

This returns a permanent attribute value corresponding to the given key. If the key is not found in the list of permanent attributes, then it will be called to generate the value, and the key will from then on be associated with the value.

Overrides:: getPermanentAttribute in class MutableHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: MutableHttpServletRequest.getPermanentAttribute(atg.servlet.AttributeFactory)

getPostParameter

public java.lang.String getPostParameter(java.lang.String pKey,
                                         int pIndex)

Description copied from class: DynamoHttpServletRequest

Returns the nth Post parameter matching the given key and index. Returns null if the key is not found or if there were not enough parameters with the same key.
Causes the Post data to parsed and cached if it wasn't already.

Overrides:: getPostParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pIndex -
Returns:
See Also:: DynamoHttpServletRequest.getPostParameter(java.lang.String, int)

getPostParameter

public java.lang.String getPostParameter(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getPostParameter in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getPostParameter(java.lang.String)

getPostParameterCount

public int getPostParameterCount(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

Returns the number of Post parameters that have the same key.
Causes the Post data to parsed and cached if it wasn't already.

Overrides:: getPostParameterCount in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getPostParameterCount(java.lang.String)

getPostParameterNames

public java.util.Enumeration getPostParameterNames()

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getPostParameterNames in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getPostParameterNames()

getPostParameterValues

public java.lang.String[] getPostParameterValues(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getPostParameterValues in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getPostParameterValues(java.lang.String)

getProtocol

public java.lang.String getProtocol()

Description copied from class: MutableHttpServletRequest

Wraps the call to getProtocol

Specified by:: getProtocol in interface javax.servlet.ServletRequest
Overrides:: getProtocol in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getProtocol()

getQueryParameter

public java.lang.String getQueryParameter(java.lang.String pKey,
                                          int pIndex)

Description copied from class: DynamoHttpServletRequest

Returns the nth Query parameter matching the given key and index. Returns null if the key is not found or if there were not enough parameters with the same key.
Causes the Query String to parsed and cached if it wasn't already.

Overrides:: getQueryParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pIndex -
Returns:
See Also:: DynamoHttpServletRequest.getQueryParameter(java.lang.String, int)

getQueryParameter

public java.lang.String getQueryParameter(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

Returns the first parameter matching the given key from the Query String, or null if the key is not found.
Causes the Query String to parsed and cached if it wasn't already.

Overrides:: getQueryParameter in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getQueryParameter(java.lang.String)

getQueryParameterCount

public int getQueryParameterCount(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

Returns the number of Query parameters that have the same key.
Causes the Query String to parsed and cached if it wasn't already.

Overrides:: getQueryParameterCount in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getQueryParameterCount(java.lang.String)

getQueryParameterNames

public java.util.Enumeration getQueryParameterNames()

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getQueryParameterNames in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getQueryParameterNames()

getQueryParameterValues

public java.lang.String[] getQueryParameterValues(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getQueryParameterValues in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getQueryParameterValues(java.lang.String)

getQueryString

public java.lang.String getQueryString()

Description copied from class: MutableHttpServletRequest

Wraps the call to getQueryString

Specified by:: getQueryString in interface javax.servlet.http.HttpServletRequest
Overrides:: getQueryString in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getQueryString()

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Description copied from class: MutableHttpServletRequest

Returns an input stream for reading the request body.

Specified by:: getReader in interface javax.servlet.ServletRequest
Overrides:: getReader in class MutableHttpServletRequest

Returns:
Throws:: java.io.IOException
See Also:: MutableHttpServletRequest.getReader()

getRealPath

public java.lang.String getRealPath(java.lang.String pPath)

Description copied from class: MutableHttpServletRequest

Wraps the call to getRealPath

Specified by:: getRealPath in interface javax.servlet.ServletRequest
Overrides:: getRealPath in class DynamoHttpServletRequest

Parameters:: pPath -
Returns:
See Also:: DynamoHttpServletRequest.getRealPath(java.lang.String)

getRemoteAddr

public java.lang.String getRemoteAddr()

Description copied from class: MutableHttpServletRequest

Wraps the call to getRemoteAddr

Specified by:: getRemoteAddr in interface javax.servlet.ServletRequest
Overrides:: getRemoteAddr in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getRemoteAddr()

getRemoteHost

public java.lang.String getRemoteHost()

Description copied from class: MutableHttpServletRequest

Wraps the call to getRemoteHost

Specified by:: getRemoteHost in interface javax.servlet.ServletRequest
Overrides:: getRemoteHost in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getRemoteHost()

getRemotePort

public int getRemotePort()

Specified by:: getRemotePort in interface javax.servlet.ServletRequest
Overrides:: getRemotePort in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getRemotePort()

getRemoteUser

public java.lang.String getRemoteUser()

Description copied from class: MutableHttpServletRequest

Wraps the call to getRemoteUser

Specified by:: getRemoteUser in interface javax.servlet.http.HttpServletRequest
Overrides:: getRemoteUser in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getRemoteUser()

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(javax.servlet.ServletContext pContext,
                                                            java.lang.String pPath)

Description copied from class: DynamoHttpServletRequest

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path and in the given servlet context. A 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.

Overrides:: getRequestDispatcher in class DynamoHttpServletRequest

Parameters:: pContext -; pPath -
Returns:
See Also:: DynamoHttpServletRequest.getRequestDispatcher(javax.servlet.ServletContext, java.lang.String)

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String pPath)

Wrap request dispatcher to allow forward calls to be intercepted.

Specified by:: getRequestDispatcher in interface javax.servlet.ServletRequest
Overrides:: getRequestDispatcher in class DynamoHttpServletRequest

Parameters:: pPath -
Returns:
See Also:: DynamoHttpServletRequest.getRequestDispatcher(java.lang.String)

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Description copied from class: DynamoHttpServletRequest

Gets the session id specified with this request. This may differ from the actual session id. For example, if the request specified an id for an invalid session, then this will get a new session with a new id. On the first request for a new user that does not have a cookie for this server, this will return null since that request did not supply a session id. If you want to get the session id associated with this request, call getSession(true).getId().

Specified by:: getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
Overrides:: getRequestedSessionId in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestedSessionId()

getRequestForComparison

public DynamoHttpServletRequest getRequestForComparison()

Description copied from class: DynamoHttpServletRequest

Returns a reference to this.

Overrides:: getRequestForComparison in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestForComparison()

getRequestLocale

public atg.servlet.RequestLocale getRequestLocale()

Description copied from class: DynamoHttpServletRequest

Returns the request locale

Overrides:: getRequestLocale in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestLocale()

getRequestLocalePath

public ComponentName getRequestLocalePath()

Description copied from class: DynamoHttpServletRequest

This value gets set by the HeadPipelineServlet when the request is initially created.

The path to the request locale component.

Overrides:: getRequestLocalePath in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestLocalePath()

getRequestScope

public NameContext getRequestScope()

Overrides:: getRequestScope in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestScope()

getRequestScopeManager

public RequestScopeManager getRequestScopeManager()

Description copied from class: DynamoHttpServletRequest

Returns the RequestScopeManager

Overrides:: getRequestScopeManager in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestScopeManager()

getRequestURI

public java.lang.String getRequestURI()

Description copied from class: DynamoHttpServletRequest

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. Default is to follow the specification.

Specified by:: getRequestURI in interface javax.servlet.http.HttpServletRequest
Overrides:: getRequestURI in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestURI()

getRequestURIWithQueryString

public java.lang.String getRequestURIWithQueryString()

Description copied from class: DynamoHttpServletRequest

Returns the first line of the HTTP request. This is the RequestURI including the query parameters (all of those followed by the ? in the URL if any). If there is an embedded session id or any of the old style "URL parameters" (those specified with a ;$urlparam$), those will not be returned by this method.

Overrides:: getRequestURIWithQueryString in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRequestURIWithQueryString()

getRequestURL

public java.lang.StringBuffer getRequestURL()

Description copied from class: MutableHttpServletRequest

Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.

Because this method returns a StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.

This method is useful for creating redirect messages and for reporting errors.

Specified by:: getRequestURL in interface javax.servlet.http.HttpServletRequest
Overrides:: getRequestURL in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getRequestURL()

getResponse

public DynamoHttpServletResponse getResponse()

Overrides:: getResponse in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getResponse()

getRestorableSessionIdFromURL

public java.lang.String getRestorableSessionIdFromURL()

Description copied from class: DynamoHttpServletRequest

Gets the session id taken from the URL which, if it differs from requestedSessionID, indicates the need to restore a session. No relation to URLSessionIdSpecifier.

Overrides:: getRestorableSessionIdFromURL in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getRestorableSessionIdFromURL()

getScheme

public java.lang.String getScheme()

Description copied from class: MutableHttpServletRequest

Wraps the call to getScheme

Specified by:: getScheme in interface javax.servlet.ServletRequest
Overrides:: getScheme in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getScheme()

getScrambleKey

public byte[] getScrambleKey()

Description copied from class: DynamoHttpServletRequest

Returns the Scramble Key property

Overrides:: getScrambleKey in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getScrambleKey()

getServerName

public java.lang.String getServerName()

Description copied from class: MutableHttpServletRequest

Wraps the call to getServerName

Specified by:: getServerName in interface javax.servlet.ServletRequest
Overrides:: getServerName in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getServerName()

getServerPort

public int getServerPort()

Description copied from class: MutableHttpServletRequest

Wraps the call to getServerPort

Specified by:: getServerPort in interface javax.servlet.ServletRequest
Overrides:: getServerPort in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getServerPort()

getServletPath

public java.lang.String getServletPath()

Description copied from class: MutableHttpServletRequest

Wraps the call to getServletPath

Specified by:: getServletPath in interface javax.servlet.http.HttpServletRequest
Overrides:: getServletPath in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.getServletPath()

getSession

public javax.servlet.http.HttpSession getSession()

Description copied from class: DynamoHttpServletRequest

Returns the current session associated with this request, or if the request does not have a session, creates one.

Specified by:: getSession in interface javax.servlet.http.HttpServletRequest
Overrides:: getSession in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getSession()

getSession

public javax.servlet.http.HttpSession getSession(boolean pCreate)

Description copied from class: DynamoHttpServletRequest

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.

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.

Specified by:: getSession in interface javax.servlet.http.HttpServletRequest
Overrides:: getSession in class DynamoHttpServletRequest

Parameters:: pCreate -
Returns:
See Also:: DynamoHttpServletRequest.getSession(boolean)

getSessionConfirmationNumber

public long getSessionConfirmationNumber()

Description copied from class: DynamoHttpServletRequest

Get the session confirmation number. Used on form submits.

Overrides:: getSessionConfirmationNumber in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getSessionConfirmationNumber()

getSessionNameContext

public NameContext getSessionNameContext()

Description copied from class: DynamoHttpServletRequest

Return the session name context.

Overrides:: getSessionNameContext in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getSessionNameContext()

getSessionRequest

public HttpSessionRequest getSessionRequest()

Deprecated.

Description copied from class: DynamoHttpServletRequest

Returns the Session Request property

Overrides:: getSessionRequest in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getSessionRequest()

getSessionRequest

public HttpSessionRequest getSessionRequest(boolean pCreate)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Returns the Session Request property

Overrides:: getSessionRequest in class DynamoHttpServletRequest

Parameters:: pCreate -
Returns:
See Also:: DynamoHttpServletRequest.getSessionRequest(boolean)

getURLParameter

public java.lang.String getURLParameter(java.lang.String pKey,
                                        int pIndex)

Description copied from class: DynamoHttpServletRequest

Returns the nth URL parameter matching the given key and index. Returns null if the key is not found or if there were not enough parameters with the same key.
Causes the URL String to parsed and cached if it wasn't already.

Overrides:: getURLParameter in class DynamoHttpServletRequest

Parameters:: pKey -; pIndex -
Returns:
See Also:: DynamoHttpServletRequest.getURLParameter(java.lang.String, int)

getURLParameter

public java.lang.String getURLParameter(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getURLParameter in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getURLParameter(java.lang.String)

getURLParameterCount

public int getURLParameterCount(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

Returns the number of URL parameters that have the same key.
Causes the URL String to parsed and cached if it wasn't already.

Overrides:: getURLParameterCount in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getURLParameterCount(java.lang.String)

getURLParameterNames

public java.util.Enumeration getURLParameterNames()

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getURLParameterNames in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getURLParameterNames()

getURLParameterString

public java.lang.String getURLParameterString()

Description copied from class: DynamoHttpServletRequest

Returns the URL Parameter String property string

Overrides:: getURLParameterString in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getURLParameterString()

getURLParameterValues

public java.lang.String[] getURLParameterValues(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

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.

Overrides:: getURLParameterValues in class DynamoHttpServletRequest

Parameters:: pKey -
Returns:
See Also:: DynamoHttpServletRequest.getURLParameterValues(java.lang.String)

getURLSessionIdSpecifier

public java.lang.String getURLSessionIdSpecifier()

Description copied from class: DynamoHttpServletRequest

Returns the URL Session ID Specifier

Overrides:: getURLSessionIdSpecifier in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getURLSessionIdSpecifier()

getUserAuthenticator

public UserAuthenticator getUserAuthenticator()

Description copied from class: DynamoHttpServletRequest

Returns the user authenticator to use if we are running in DAF

Overrides:: getUserAuthenticator in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getUserAuthenticator()

getUserPrincipal

public java.security.Principal getUserPrincipal()

Description copied from class: DynamoHttpServletRequest

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 a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null.

Specified by:: getUserPrincipal in interface javax.servlet.http.HttpServletRequest
Overrides:: getUserPrincipal in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getUserPrincipal()

getWebApplication

public atg.servlet.minimal.WebApplicationInterface getWebApplication()

Description copied from class: DynamoHttpServletRequest

Return the J2EE WebApplicationInterface associated with this request (if any).

Overrides:: getWebApplication in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWebApplication()

getWebPools

public atg.servlet.WebPools getWebPools()

Description copied from class: DynamoHttpServletRequest

Return the WebPools object associated with this request. The WebPools object contains various pools which are used to fulfill request-related requests for resources.

Overrides:: getWebPools in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWebPools()

getWindowScope

public NameContext getWindowScope()

Overrides:: getWindowScope in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWindowScope()

getWindowScopeManager

public atg.nucleus.WindowScopeManager getWindowScopeManager()

Description copied from class: DynamoHttpServletRequest

Returns the WindowScopeManager

Overrides:: getWindowScopeManager in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWindowScopeManager()

getWorkingDirectory

public java.lang.String getWorkingDirectory()

Description copied from class: DynamoHttpServletRequest

Returns the current request's working directory, which always ends in "/"

Overrides:: getWorkingDirectory in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWorkingDirectory()

getWrapper

public javax.servlet.ServletRequestWrapper getWrapper()

Description copied from class: DynamoHttpServletRequest

Returns the ServletRequestWrapper wrapping this request. If there are multiple wrappers created in the course of executing the pipeline or filter chain this should be the outermost such wrapper.

Overrides:: getWrapper in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.getWrapper()

hashCode

public int hashCode()

Overrides:: hashCode in class java.lang.Object

Returns:
See Also:: Object.hashCode()

hasRequestScope

public boolean hasRequestScope()

Description copied from class: DynamoHttpServletRequest

Returns true if this request has had a request scope created for it yet.

Overrides:: hasRequestScope in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.hasRequestScope()

isAfterGetsClaimed

public boolean isAfterGetsClaimed()

Overrides:: isAfterGetsClaimed in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isAfterGetsClaimed()

isBrowserType

public boolean isBrowserType(java.lang.String pFeature)

Description copied from class: DynamoHttpServletRequest

Returns true if the browser supports the given feature

Overrides:: isBrowserType in class DynamoHttpServletRequest

Parameters:: pFeature -
Returns:
See Also:: DynamoHttpServletRequest.isBrowserType(java.lang.String)

isDelayedRequest

public boolean isDelayedRequest()

Description copied from class: DynamoHttpServletRequest

Returns the isDelayedRequest property

Overrides:: isDelayedRequest in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isDelayedRequest()

isDynamoPipeline

public boolean isDynamoPipeline()

Overrides:: isDynamoPipeline in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isDynamoPipeline()

isInitialized

public boolean isInitialized()

Description copied from class: DynamoHttpServletRequest

Returns true if this object is initialized.

Overrides:: isInitialized in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isInitialized()

isInTemplatePage

public boolean isInTemplatePage()

Overrides:: isInTemplatePage in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isInTemplatePage()

isLoggingDebug

public boolean isLoggingDebug()

Description copied from class: DynamoHttpServletRequest

This method returns whether or not an debug log event should be broadcast.

Specified by:: isLoggingDebug in interface ApplicationLogging
Overrides:: isLoggingDebug in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isLoggingDebug()

isLoggingError

public boolean isLoggingError()

Description copied from class: DynamoHttpServletRequest

This method returns whether or not an error log event should be broadcast.

Specified by:: isLoggingError in interface ApplicationLogging
Overrides:: isLoggingError in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isLoggingError()

isLoggingInfo

public boolean isLoggingInfo()

Description copied from class: DynamoHttpServletRequest

This method returns whether or not an info log event should be broadcast.

Specified by:: isLoggingInfo in interface ApplicationLogging
Overrides:: isLoggingInfo in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isLoggingInfo()

isLoggingWarning

public boolean isLoggingWarning()

Description copied from class: DynamoHttpServletRequest

This method returns whether or not an warning log event should be broadcast.

Specified by:: isLoggingWarning in interface ApplicationLogging
Overrides:: isLoggingWarning in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isLoggingWarning()

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Description copied from class: DynamoHttpServletRequest

Checks whether the session id specified by this request came in as a cookie. (The requested session may not be one returned by the getSession method.)

Specified by:: isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
Overrides:: isRequestedSessionIdFromCookie in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isRequestedSessionIdFromCookie()

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Description copied from class: DynamoHttpServletRequest

Checks whether the session id specified by this request came in as part of the URL. (The requested session may not be the one returned by the getSession method.)

Specified by:: isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
Overrides:: isRequestedSessionIdFromUrl in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isRequestedSessionIdFromUrl()

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Description copied from class: MutableHttpServletRequest

Checks whether the session id specified by this request came in as part of the URL. (The requested session may not be the one returned by the getSession method.)

Specified by:: isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
Overrides:: isRequestedSessionIdFromURL in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.isRequestedSessionIdFromURL()

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Description copied from class: DynamoHttpServletRequest

Checks whether this request is associated with a session that is valid in the current session context. If it is not valid, the requested session will never be returned from the getSession method.

Specified by:: isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
Overrides:: isRequestedSessionIdValid in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.isRequestedSessionIdValid()

isSecure

public boolean isSecure()

Description copied from class: MutableHttpServletRequest

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS

Specified by:: isSecure in interface javax.servlet.ServletRequest
Overrides:: isSecure in class MutableHttpServletRequest

Returns:
See Also:: MutableHttpServletRequest.isSecure()

isUserInRole

public boolean isUserInRole(java.lang.String pRole)

Description copied from class: DynamoHttpServletRequest

Overrides isUserInRole 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.

Specified by:: isUserInRole in interface javax.servlet.http.HttpServletRequest
Overrides:: isUserInRole in class DynamoHttpServletRequest

Parameters:: pRole -
Returns:
See Also:: DynamoHttpServletRequest.isUserInRole(java.lang.String)

logDebug

public void logDebug(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an debug event with the specified message and Throwable

Specified by:: logDebug in interface ApplicationLogging
Overrides:: logDebug in class DynamoHttpServletRequest

Parameters:: pMessage -; pThrowable -
See Also:: DynamoHttpServletRequest.logDebug(java.lang.String, java.lang.Throwable)

logDebug

public void logDebug(java.lang.String pMessage)

Description copied from class: DynamoHttpServletRequest

Logs an debug event with the specified message

Specified by:: logDebug in interface ApplicationLogging
Overrides:: logDebug in class DynamoHttpServletRequest

Parameters:: pMessage -
See Also:: DynamoHttpServletRequest.logDebug(java.lang.String)

logDebug

public void logDebug(java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an debug event with the specified Throwable

Specified by:: logDebug in interface ApplicationLogging
Overrides:: logDebug in class DynamoHttpServletRequest

Parameters:: pThrowable -
See Also:: DynamoHttpServletRequest.logDebug(java.lang.Throwable)

logError

public void logError(java.lang.String pMessage,
                     java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an error event with the specified message and Throwable

Specified by:: logError in interface ApplicationLogging
Overrides:: logError in class DynamoHttpServletRequest

Parameters:: pMessage -; pThrowable -
See Also:: DynamoHttpServletRequest.logError(java.lang.String, java.lang.Throwable)

logError

public void logError(java.lang.String pMessage)

Description copied from class: DynamoHttpServletRequest

Logs an error event with the specified message

Specified by:: logError in interface ApplicationLogging
Overrides:: logError in class DynamoHttpServletRequest

Parameters:: pMessage -
See Also:: DynamoHttpServletRequest.logError(java.lang.String)

logError

public void logError(java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an error event with the specified Throwable

Specified by:: logError in interface ApplicationLogging
Overrides:: logError in class DynamoHttpServletRequest

Parameters:: pThrowable -
See Also:: DynamoHttpServletRequest.logError(java.lang.Throwable)

logInfo

public void logInfo(java.lang.String pMessage,
                    java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an info event with the specified message and Throwable

Specified by:: logInfo in interface ApplicationLogging
Overrides:: logInfo in class DynamoHttpServletRequest

Parameters:: pMessage -; pThrowable -
See Also:: DynamoHttpServletRequest.logInfo(java.lang.String, java.lang.Throwable)

logInfo

public void logInfo(java.lang.String pMessage)

Description copied from class: DynamoHttpServletRequest

Logs an info event with the specified message

Specified by:: logInfo in interface ApplicationLogging
Overrides:: logInfo in class DynamoHttpServletRequest

Parameters:: pMessage -
See Also:: DynamoHttpServletRequest.logInfo(java.lang.String)

logInfo

public void logInfo(java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an info event with the specified Throwable

Specified by:: logInfo in interface ApplicationLogging
Overrides:: logInfo in class DynamoHttpServletRequest

Parameters:: pThrowable -
See Also:: DynamoHttpServletRequest.logInfo(java.lang.Throwable)

logWarning

public void logWarning(java.lang.String pMessage,
                       java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an warning event with the specified message and Throwable

Specified by:: logWarning in interface ApplicationLogging
Overrides:: logWarning in class DynamoHttpServletRequest

Parameters:: pMessage -; pThrowable -
See Also:: DynamoHttpServletRequest.logWarning(java.lang.String, java.lang.Throwable)

logWarning

public void logWarning(java.lang.String pMessage)

Description copied from class: DynamoHttpServletRequest

Logs an warning event with the specified message

Specified by:: logWarning in interface ApplicationLogging
Overrides:: logWarning in class DynamoHttpServletRequest

Parameters:: pMessage -
See Also:: DynamoHttpServletRequest.logWarning(java.lang.String)

logWarning

public void logWarning(java.lang.Throwable pThrowable)

Description copied from class: DynamoHttpServletRequest

Logs an warning event with the specified Throwable

Specified by:: logWarning in interface ApplicationLogging
Overrides:: logWarning in class DynamoHttpServletRequest

Parameters:: pThrowable -
See Also:: DynamoHttpServletRequest.logWarning(java.lang.Throwable)

performExitTracking

public java.lang.String performExitTracking(java.lang.String pURL)

Description copied from class: DynamoHttpServletRequest

Returns an encoded URL that can be decoded by the exit tracking handler

Specified by:: performExitTracking in interface atg.servlet.exittracking.ExitTrackingHandler
Overrides:: performExitTracking in class DynamoHttpServletRequest

Parameters:: pURL -
Returns:
See Also:: DynamoHttpServletRequest.performExitTracking(java.lang.String)

popDefaultParameters

public void popDefaultParameters()

Description copied from class: DynamoHttpServletRequest

Pops the first dictionary for this frame off the stack. If you used pushDefaultParameters, you should use popDefaultParameters to remove this dictionary.

Overrides:: popDefaultParameters in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.popDefaultParameters()

popFrame

public void popFrame()

Description copied from class: DynamoHttpServletRequest

When the frame is complete, this pops the parameter stack back to the state before the pushFrame. Individual popParameters calls that match the pushParameters are not necessary

Overrides:: popFrame in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.popFrame()

popParameters

public void popParameters()

Description copied from class: DynamoHttpServletRequest

Pops the dictionary of parameters on top of the stack.

Overrides:: popParameters in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.popParameters()

printRequest

public void printRequest(java.io.PrintStream pOut)

Description copied from class: DynamoHttpServletRequest

Prints all the elements of the request

Overrides:: printRequest in class DynamoHttpServletRequest

Parameters:: pOut -
See Also:: DynamoHttpServletRequest.printRequest(java.io.PrintStream)

pushDefaultParameters

public void pushDefaultParameters(java.util.Dictionary pDict)

Description copied from class: DynamoHttpServletRequest

This sets a new dictionary of parameters at the top of the current frame. A frame occurs for each droplet invocation. This allows the parameter stack defined in the invocation to override a parameter stack defined in the page. The parameter stack in the page will use pushDefaultParameters.

Overrides:: pushDefaultParameters in class DynamoHttpServletRequest

Parameters:: pDict -
See Also:: DynamoHttpServletRequest.pushDefaultParameters(java.util.Dictionary)

pushFrame

public void pushFrame()

Description copied from class: DynamoHttpServletRequest

A frame is defined for each droplet invocation. The pushFrame call is made right before the droplet is invoked, the popFrame call is made when the droplet invocation is finished.

Overrides:: pushFrame in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.pushFrame()

pushParameters

public void pushParameters(java.util.Dictionary pDict)

Description copied from class: DynamoHttpServletRequest

Adds a dictionary to the list of parameters to check. Parameters in this dictionary are added to the list of parameters in the request and override any existing parameters. Parameters should be defined as strings.

Overrides:: pushParameters in class DynamoHttpServletRequest

Parameters:: pDict -
See Also:: DynamoHttpServletRequest.pushParameters(java.util.Dictionary)

removeAttribute

public void removeAttribute(java.lang.String pName)

Description copied from class: MutableHttpServletRequest

Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled. Attribute names should follow the same conventions as package names. Names beginning with java.*, javax.*, and com.sun.*, are reserved for use by Sun Microsystems.

Specified by:: removeAttribute in interface javax.servlet.ServletRequest
Overrides:: removeAttribute in class MutableHttpServletRequest

Parameters:: pName -
See Also:: MutableHttpServletRequest.removeAttribute(java.lang.String)

removeParameter

public java.lang.Object removeParameter(java.lang.String pName)

Description copied from class: DynamoHttpServletRequest

Removes the definition of the parameter specified. This will only remove the definition of a parameter at the top of the stack (i.e. one that was set with setParameter with a matching number of subsequent calls to pushParameters and popParameters).

Overrides:: removeParameter in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.removeParameter(java.lang.String)

removePersistentQueryParameter

public void removePersistentQueryParameter(java.lang.String pKey)

Description copied from class: DynamoHttpServletRequest

Removes a persistent query parameter, which will no longer be encoded in any subsequent calls to encodeURL.

Overrides:: removePersistentQueryParameter in class DynamoHttpServletRequest

Parameters:: pKey -
See Also:: DynamoHttpServletRequest.removePersistentQueryParameter(java.lang.String)

removeSessionFromRequest

public void removeSessionFromRequest()

Deprecated.

Description copied from class: DynamoHttpServletRequest

Removes the current session from this request. This is called automatically when you invalidate the session for a particular request.

Overrides:: removeSessionFromRequest in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.removeSessionFromRequest()

resolveGlobalName

public java.lang.Object resolveGlobalName(ComponentName pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a global name in the nucleus component hierarchy.

Overrides:: resolveGlobalName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveGlobalName(atg.nucleus.naming.ComponentName)

resolveGlobalName

public java.lang.Object resolveGlobalName(java.lang.String pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a global name in the nucleus component hierarchy.

Overrides:: resolveGlobalName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveGlobalName(java.lang.String)

resolveName

public java.lang.Object resolveName(ComponentName pName,
                                    boolean pCreate)

Description copied from class: DynamoHttpServletRequest

Resolves a name in the nucleus hierarchy searching session, global, window and request scopes.

Overrides:: resolveName in class DynamoHttpServletRequest

Parameters:: pName -; pCreate -
Returns:
See Also:: DynamoHttpServletRequest.resolveName(atg.nucleus.naming.ComponentName, boolean)

resolveName

public java.lang.Object resolveName(ComponentName pName)

Description copied from class: DynamoHttpServletRequest

Resolves a name in the nucleus hierarchy searching session, global, window and request scopes. If the component does not yet exist and its configuration is defined, it is created automatically by this call.

Overrides:: resolveName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveName(atg.nucleus.naming.ComponentName)

resolveName

public java.lang.Object resolveName(java.lang.String pName,
                                    boolean pCreate)

Description copied from class: DynamoHttpServletRequest

Resolves a name in the nucleus hierarchy searching session, global, and request scopes.

Overrides:: resolveName in class DynamoHttpServletRequest

Parameters:: pName -; pCreate -
Returns:
See Also:: DynamoHttpServletRequest.resolveName(java.lang.String, boolean)

resolveName

public java.lang.Object resolveName(java.lang.String pName)

Description copied from class: DynamoHttpServletRequest

Resolves a name in the nucleus hierarchy searching session, global, and request scopes. If the component does not yet exist and its configuration is defined, it is created automatically by this call.

Specified by:: resolveName in interface NameResolver
Overrides:: resolveName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveName(java.lang.String)

resolveRequestName

public java.lang.Object resolveRequestName(ComponentName pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a request name.

Overrides:: resolveRequestName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveRequestName(atg.nucleus.naming.ComponentName)

resolveRequestName

public java.lang.Object resolveRequestName(java.lang.String pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a request name.

Overrides:: resolveRequestName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveRequestName(java.lang.String)

resolveSessionName

public java.lang.Object resolveSessionName(ComponentName pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a session name.

Overrides:: resolveSessionName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveSessionName(atg.nucleus.naming.ComponentName)

resolveSessionName

public java.lang.Object resolveSessionName(java.lang.String pName)

Deprecated.

Description copied from class: DynamoHttpServletRequest

Resolves a session name.

Overrides:: resolveSessionName in class DynamoHttpServletRequest

Parameters:: pName -
Returns:
See Also:: DynamoHttpServletRequest.resolveSessionName(java.lang.String)

serviceLocalParameter

public boolean serviceLocalParameter(ParameterName pName,
                                     javax.servlet.ServletRequest pReq,
                                     javax.servlet.ServletResponse pRes)
                              throws javax.servlet.ServletException,
                                     java.io.IOException

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceLocalParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceLocalParameter(atg.nucleus.naming.ParameterName, javax.servlet.ServletRequest, javax.servlet.ServletResponse)

serviceLocalParameter

public boolean serviceLocalParameter(java.lang.String pName,
                                     javax.servlet.ServletRequest pReq,
                                     javax.servlet.ServletResponse pRes)
                              throws javax.servlet.ServletException,
                                     java.io.IOException

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceLocalParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceLocalParameter(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletResponse)

serviceParameter

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

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -; pCvt -; pCvtArgs -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceParameter(atg.nucleus.naming.ParameterName, javax.servlet.ServletRequest, javax.servlet.ServletResponse, atg.droplet.TagConverter, java.util.Properties)

serviceParameter

public boolean serviceParameter(ParameterName pName,
                                javax.servlet.ServletRequest pReq,
                                javax.servlet.ServletResponse pRes)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceParameter(atg.nucleus.naming.ParameterName, javax.servlet.ServletRequest, javax.servlet.ServletResponse)

serviceParameter

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

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -; pCvt -; pCvtArgs -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceParameter(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletResponse, atg.droplet.TagConverter, java.util.Properties)

serviceParameter

public boolean serviceParameter(java.lang.String pName,
                                javax.servlet.ServletRequest pReq,
                                javax.servlet.ServletResponse pRes)
                         throws javax.servlet.ServletException,
                                java.io.IOException

Description copied from class: DynamoHttpServletRequest

This is a convenience function for putting the value of a specified parameter to the output stream. It handles parameters that are both servlets and strings.

Overrides:: serviceParameter in class DynamoHttpServletRequest

Parameters:: pName -; pReq -; pRes -
Returns:
Throws:: javax.servlet.ServletException; java.io.IOException
See Also:: DynamoHttpServletRequest.serviceParameter(java.lang.String, javax.servlet.ServletRequest, javax.servlet.ServletResponse)

setAfterGetsClaimed

public void setAfterGetsClaimed(boolean pAfterGetsClaimed)

Description copied from class: DynamoHttpServletRequest

Flag indicating if someone in the request has taken responsibility for calling the afterGets methods. This should be set by the first element that encouters the request, which could either be the DropletEventServlet, or a PageTag.

Overrides:: setAfterGetsClaimed in class DynamoHttpServletRequest

Parameters:: pAfterGetsClaimed -
See Also:: DynamoHttpServletRequest.setAfterGetsClaimed(boolean)

setAttribute

public void setAttribute(java.lang.String pName,
                         java.lang.Object pValue)

Description copied from class: MutableHttpServletRequest

Sets an attribute with the given name and value. Overwrites the value of any attribute with the same name.

Specified by:: setAttribute in interface javax.servlet.ServletRequest
Overrides:: setAttribute in class MutableHttpServletRequest

Parameters:: pName -; pValue -
See Also:: MutableHttpServletRequest.setAttribute(java.lang.String, java.lang.Object)

setAttributeFactory

public void setAttributeFactory(java.lang.String pName,
                                AttributeFactory pFactory)

Description copied from class: MutableHttpServletRequest

Sets an attribute factory that will only be called if someone asks for the specified attribute.

Overrides:: setAttributeFactory in class MutableHttpServletRequest

Parameters:: pName -; pFactory -
See Also:: MutableHttpServletRequest.setAttributeFactory(java.lang.String, atg.servlet.AttributeFactory)

setAuthType

public void setAuthType(java.lang.String pAuthType)

Description copied from class: MutableHttpServletRequest

Sets the AuthType

Overrides:: setAuthType in class MutableHttpServletRequest

Parameters:: pAuthType -
See Also:: MutableHttpServletRequest.setAuthType(java.lang.String)

setBaseDirectory

public void setBaseDirectory(java.lang.String pBaseDir)

Description copied from class: DynamoHttpServletRequest

Sets the base directory. This is directory is prepended onto all relative URLs that are encoded. This is used when one page includes another page that is in a different directory.

Overrides:: setBaseDirectory in class DynamoHttpServletRequest

Parameters:: pBaseDir -
See Also:: DynamoHttpServletRequest.setBaseDirectory(java.lang.String)

setBrowserTyper

public void setBrowserTyper(BrowserTyper pBrowserTyper)

Description copied from class: DynamoHttpServletRequest

Sets the BrowserTyper

Overrides:: setBrowserTyper in class DynamoHttpServletRequest

Parameters:: pBrowserTyper -
See Also:: DynamoHttpServletRequest.setBrowserTyper(atg.servlet.BrowserTyper)

setCharacterEncoding

public void setCharacterEncoding(java.lang.String pEncoding)
                          throws java.io.UnsupportedEncodingException

Description copied from class: MutableHttpServletRequest

Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader().

Specified by:: setCharacterEncoding in interface javax.servlet.ServletRequest
Overrides:: setCharacterEncoding in class MutableHttpServletRequest

Parameters:: pEncoding -
Throws:: java.io.UnsupportedEncodingException
See Also:: MutableHttpServletRequest.setCharacterEncoding(java.lang.String)

setContentLength

public void setContentLength(int pContentLength)

Description copied from class: MutableHttpServletRequest

Sets the ContentLength

Overrides:: setContentLength in class MutableHttpServletRequest

Parameters:: pContentLength -
See Also:: MutableHttpServletRequest.setContentLength(int)

setContentType

public void setContentType(java.lang.String pContentType)

Description copied from class: MutableHttpServletRequest

Sets the ContentType

Overrides:: setContentType in class MutableHttpServletRequest

Parameters:: pContentType -
See Also:: MutableHttpServletRequest.setContentType(java.lang.String)

setContextPath

public void setContextPath(java.lang.String pContextPath)

Description copied from class: MutableHttpServletRequest

Sets the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "".

Overrides:: setContextPath in class MutableHttpServletRequest

Parameters:: pContextPath -
See Also:: MutableHttpServletRequest.setContextPath(java.lang.String)

setDisableExitTracking

public void setDisableExitTracking(boolean pDisableExitTracking)

Description copied from class: DynamoHttpServletRequest

If true, forces exit tracking to not be performed on this request.

Overrides:: setDisableExitTracking in class DynamoHttpServletRequest

Parameters:: pDisableExitTracking -
See Also:: DynamoHttpServletRequest.setDisableExitTracking(boolean)

setDocRootServicePrefix

public void setDocRootServicePrefix(java.lang.String pDocRootServicePrefix)

Overrides:: setDocRootServicePrefix in class DynamoHttpServletRequest

Parameters:: pDocRootServicePrefix -
See Also:: DynamoHttpServletRequest.setDocRootServicePrefix(java.lang.String)

setDynamoPipeline

public void setDynamoPipeline(boolean pDynamoPipeline)

Description copied from class: DynamoHttpServletRequest

Sets the property dynamoPipeline. This is true if the request is proceeding through the Dynamo pipeline, false if the request is proceeding through another pipeline mechanism such as the Dynamo Application Framework pipeline.

Overrides:: setDynamoPipeline in class DynamoHttpServletRequest

Parameters:: pDynamoPipeline -
See Also:: DynamoHttpServletRequest.setDynamoPipeline(boolean)

setEncodeContextPathMode

public void setEncodeContextPathMode(int pEncodeMode)

Description copied from class: DynamoHttpServletRequest

Sets the EncodeContextPathMode property.

Overrides:: setEncodeContextPathMode in class DynamoHttpServletRequest

Parameters:: pEncodeMode -
See Also:: DynamoHttpServletRequest.setEncodeContextPathMode(int)

setEncodeServletPath

public void setEncodeServletPath(boolean pEncode)

Description copied from class: DynamoHttpServletRequest

Sets the EncodeServletPath property. This determines whether or not the ServletPath is encoded into URLs encoded with the encodeURL method that start with '/'.

Overrides:: setEncodeServletPath in class DynamoHttpServletRequest

Parameters:: pEncode -
See Also:: DynamoHttpServletRequest.setEncodeServletPath(boolean)

setEncodeURL

public void setEncodeURL(boolean pEncodeURL)

Description copied from class: DynamoHttpServletRequest

Enables or disables the rewriting of subsequent URLs that are processed by this request.

Overrides:: setEncodeURL in class DynamoHttpServletRequest

Parameters:: pEncodeURL -
See Also:: DynamoHttpServletRequest.setEncodeURL(boolean)

setEventFlags

public void setEventFlags(int pEventFlags)

Description copied from class: DynamoHttpServletRequest

Change the set of JMS events that are enabled for firing with respect to this request.

Overrides:: setEventFlags in class DynamoHttpServletRequest

Parameters:: pEventFlags -
See Also:: DynamoHttpServletRequest.setEventFlags(int)

setExitTrackingHandler

public void setExitTrackingHandler(atg.servlet.exittracking.ExitTrackingHandler pExitTrackingHandler)

Description copied from class: DynamoHttpServletRequest

Sets the exit tracking handler

Overrides:: setExitTrackingHandler in class DynamoHttpServletRequest

Parameters:: pExitTrackingHandler -
See Also:: DynamoHttpServletRequest.setExitTrackingHandler(atg.servlet.exittracking.ExitTrackingHandler)

setFormEventsSent

public void setFormEventsSent(boolean pFormEventsSent)

Description copied from class: DynamoHttpServletRequest

Sets the property FormEventsSent. This is true if the DropletEventServlet has already processed form events for this request.

Overrides:: setFormEventsSent in class DynamoHttpServletRequest

Parameters:: pFormEventsSent -
See Also:: DynamoHttpServletRequest.setFormEventsSent(boolean)

setGenerateRequestLocales

public void setGenerateRequestLocales(boolean pValue)

Description copied from class: DynamoHttpServletRequest

This value gets set by the HeadPipelineServlet when the request is initially created.

Overrides:: setGenerateRequestLocales in class DynamoHttpServletRequest

Parameters:: pValue -
See Also:: DynamoHttpServletRequest.setGenerateRequestLocales(boolean)

setInitialized

public void setInitialized(boolean pInitialized)

Description copied from class: DynamoHttpServletRequest

Sets the property Initialized.

Overrides:: setInitialized in class DynamoHttpServletRequest

Parameters:: pInitialized -
See Also:: DynamoHttpServletRequest.setInitialized(boolean)

setInputStream

public void setInputStream(javax.servlet.ServletInputStream pInputStream)

Description copied from class: MutableHttpServletRequest

Sets the InputStream

Overrides:: setInputStream in class MutableHttpServletRequest

Parameters:: pInputStream -
See Also:: MutableHttpServletRequest.setInputStream(javax.servlet.ServletInputStream)

setInTemplatePage

public void setInTemplatePage(boolean pInTemplatePage)

Description copied from class: DynamoHttpServletRequest

Sets the property InTemplatePage. This is true if the request processing is currently inside of a template DSP page.

Overrides:: setInTemplatePage in class DynamoHttpServletRequest

Parameters:: pInTemplatePage -
See Also:: DynamoHttpServletRequest.setInTemplatePage(boolean)

setLinkEncoding

public void setLinkEncoding(java.lang.String pLinkEncoding)

Description copied from class: DynamoHttpServletRequest

Sets the property LinkEncoding. This property can be set to explicitly define the character encoding used to encode query arguments between pages. By default, the encoding of the current response is used. You can disable this functionality altogether by setting the LinkEncoding property to "ISO-8859-1", "ASCII" or "US-ASCII". Note that this property gets reset to null on every request so if you want this to be set on each request, you'll have to do it in a pipeline servlet.

Overrides:: setLinkEncoding in class DynamoHttpServletRequest

Parameters:: pLinkEncoding -
See Also:: DynamoHttpServletRequest.setLinkEncoding(java.lang.String)

setLog

public void setLog(ApplicationLogging pLog)

Description copied from class: DynamoHttpServletRequest

Sets the Log property

Overrides:: setLog in class DynamoHttpServletRequest

Parameters:: pLog -
See Also:: DynamoHttpServletRequest.setLog(atg.nucleus.logging.ApplicationLogging)

setLoggingDebug

public void setLoggingDebug(boolean pLogging)

Description copied from class: DynamoHttpServletRequest

Sets whether or not error log events should be logged.

Specified by:: setLoggingDebug in interface ApplicationLogging
Overrides:: setLoggingDebug in class DynamoHttpServletRequest

Parameters:: pLogging -
See Also:: DynamoHttpServletRequest.setLoggingDebug(boolean)

setLoggingError

public void setLoggingError(boolean pLogging)

Description copied from class: DynamoHttpServletRequest

Sets whether or not error log events should be logged.

Specified by:: setLoggingError in interface ApplicationLogging
Overrides:: setLoggingError in class DynamoHttpServletRequest

Parameters:: pLogging -
See Also:: DynamoHttpServletRequest.setLoggingError(boolean)

setLoggingInfo

public void setLoggingInfo(boolean pLogging)

Description copied from class: DynamoHttpServletRequest

Sets whether or not info log events should be logged.

Specified by:: setLoggingInfo in interface ApplicationLogging
Overrides:: setLoggingInfo in class DynamoHttpServletRequest

Parameters:: pLogging -
See Also:: DynamoHttpServletRequest.setLoggingInfo(boolean)

setLoggingWarning

public void setLoggingWarning(boolean pLogging)

Description copied from class: DynamoHttpServletRequest

Sets whether or not warning log events should be logged.

Specified by:: setLoggingWarning in interface ApplicationLogging
Overrides:: setLoggingWarning in class DynamoHttpServletRequest

Parameters:: pLogging -
See Also:: DynamoHttpServletRequest.setLoggingWarning(boolean)

setMethod

public void setMethod(java.lang.String pMethod)

Description copied from class: MutableHttpServletRequest

Sets the Method

Overrides:: setMethod in class MutableHttpServletRequest

Parameters:: pMethod -
See Also:: MutableHttpServletRequest.setMethod(java.lang.String)

setMimeType

public void setMimeType(java.lang.String pMimeType)

Description copied from class: DynamoHttpServletRequest

Sets the mime type in the request. If this value is not set explicitly for a request, a mime type is computed by looking up a MimeTyper attribute from the request. This mime typer will return the value of the mime type based on the suffix of the PathInfo of the request.

Overrides:: setMimeType in class DynamoHttpServletRequest

Parameters:: pMimeType -
See Also:: DynamoHttpServletRequest.setMimeType(java.lang.String)

setMimeTyper

public void setMimeTyper(MimeTyper pMimeTyper)

Description copied from class: DynamoHttpServletRequest

Sets the MimeTyper property

Overrides:: setMimeTyper in class DynamoHttpServletRequest

Parameters:: pMimeTyper -
See Also:: DynamoHttpServletRequest.setMimeTyper(atg.servlet.MimeTyper)

setNucleus

public void setNucleus(Nucleus pNucleus)

Description copied from class: DynamoHttpServletRequest

Sets the Nucleus

Overrides:: setNucleus in class DynamoHttpServletRequest

Parameters:: pNucleus -
See Also:: DynamoHttpServletRequest.setNucleus(atg.nucleus.Nucleus)

setParameter

public void setParameter(java.lang.String pName,
                         java.lang.Object pValue,
                         TagConverter pCvt,
                         java.util.Properties pCvtArgs)
                  throws javax.servlet.ServletException

Description copied from class: DynamoHttpServletRequest

Sets the value of a request parameter. This value will automatically be popped in the next call to popParameters which is done around servlet invocations.

Overrides:: setParameter in class DynamoHttpServletRequest

Parameters:: pName -; pValue -; pCvt -; pCvtArgs -
Throws:: javax.servlet.ServletException
See Also:: DynamoHttpServletRequest.setParameter(java.lang.String, java.lang.Object, atg.droplet.TagConverter, java.util.Properties)

setParameter

public void setParameter(java.lang.String pName,
                         java.lang.Object pValue)

Description copied from class: DynamoHttpServletRequest

Sets the value of a request parameter. This value will automatically be popped in the next call to popParameters which is done around servlet invocations.

Overrides:: setParameter in class DynamoHttpServletRequest

Parameters:: pName -; pValue -
See Also:: DynamoHttpServletRequest.setParameter(java.lang.String, java.lang.Object)

setParameterDelimiter

public void setParameterDelimiter(java.lang.String pParameterDelimiter)

Description copied from class: DynamoHttpServletRequest

Sets the parameterDelimiter property

Overrides:: setParameterDelimiter in class DynamoHttpServletRequest

Parameters:: pParameterDelimiter -
See Also:: DynamoHttpServletRequest.setParameterDelimiter(java.lang.String)

setParameterHandler

public void setParameterHandler(atg.servlet.ParameterHandler pParameterHandler)

Description copied from class: DynamoHttpServletRequest

Sets the parameter handler

Overrides:: setParameterHandler in class DynamoHttpServletRequest

Parameters:: pParameterHandler -
See Also:: DynamoHttpServletRequest.setParameterHandler(atg.servlet.ParameterHandler)

setPathInfo

public void setPathInfo(java.lang.String pPathInfo)

Description copied from class: MutableHttpServletRequest

Sets the PathInfo

Overrides:: setPathInfo in class MutableHttpServletRequest

Parameters:: pPathInfo -
See Also:: MutableHttpServletRequest.setPathInfo(java.lang.String)

setPathTranslated

public void setPathTranslated(java.lang.String pPathTranslated)

Description copied from class: MutableHttpServletRequest

Sets the PathTranslated

Overrides:: setPathTranslated in class MutableHttpServletRequest

Parameters:: pPathTranslated -
See Also:: MutableHttpServletRequest.setPathTranslated(java.lang.String)

setProtocol

public void setProtocol(java.lang.String pProtocol)

Description copied from class: MutableHttpServletRequest

Sets the Protocol

Overrides:: setProtocol in class MutableHttpServletRequest

Parameters:: pProtocol -
See Also:: MutableHttpServletRequest.setProtocol(java.lang.String)

setQueryString

public void setQueryString(java.lang.String pQueryString)

Description copied from class: MutableHttpServletRequest

Sets the QueryString

Overrides:: setQueryString in class MutableHttpServletRequest

Parameters:: pQueryString -
See Also:: MutableHttpServletRequest.setQueryString(java.lang.String)

setRemoteAddr

public void setRemoteAddr(java.lang.String pRemoteAddr)

Description copied from class: MutableHttpServletRequest

Sets the RemoteAddr

Overrides:: setRemoteAddr in class MutableHttpServletRequest

Parameters:: pRemoteAddr -
See Also:: MutableHttpServletRequest.setRemoteAddr(java.lang.String)

setRemoteHost

public void setRemoteHost(java.lang.String pRemoteHost)

Description copied from class: MutableHttpServletRequest

Sets the RemoteHost

Overrides:: setRemoteHost in class MutableHttpServletRequest

Parameters:: pRemoteHost -
See Also:: MutableHttpServletRequest.setRemoteHost(java.lang.String)

setRemoteUser

public void setRemoteUser(java.lang.String pRemoteUser)

Description copied from class: MutableHttpServletRequest

Sets the RemoteUser

Overrides:: setRemoteUser in class MutableHttpServletRequest

Parameters:: pRemoteUser -
See Also:: MutableHttpServletRequest.setRemoteUser(java.lang.String)

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest pRequest)

Description copied from class: DynamoHttpServletRequest

Sets the HttpServletRequest embedded by this

Overrides:: setRequest in class DynamoHttpServletRequest

Parameters:: pRequest -
See Also:: DynamoHttpServletRequest.setRequest(javax.servlet.http.HttpServletRequest)

setRequestLocale

public void setRequestLocale(atg.servlet.RequestLocale pLocale)

Description copied from class: DynamoHttpServletRequest

Sets the request locale

Overrides:: setRequestLocale in class DynamoHttpServletRequest

Parameters:: pLocale -
See Also:: DynamoHttpServletRequest.setRequestLocale(atg.servlet.RequestLocale)

setRequestLocalePath

public void setRequestLocalePath(ComponentName pValue)

Description copied from class: DynamoHttpServletRequest

This value gets set by the HeadPipelineServlet when the request is initially created.

The path to the request locale component.

Overrides:: setRequestLocalePath in class DynamoHttpServletRequest

Parameters:: pValue -
See Also:: DynamoHttpServletRequest.setRequestLocalePath(atg.nucleus.naming.ComponentName)

setRequestScope

public void setRequestScope(NameContext pRequestScope)

Description copied from class: DynamoHttpServletRequest

Sets the property RequestScope.

Overrides:: setRequestScope in class DynamoHttpServletRequest

Parameters:: pRequestScope -
See Also:: DynamoHttpServletRequest.setRequestScope(atg.naming.NameContext)

setRequestScopeManager

public void setRequestScopeManager(RequestScopeManager pRequestScopeManager)

Description copied from class: DynamoHttpServletRequest

Sets the RequestScopeManager

Overrides:: setRequestScopeManager in class DynamoHttpServletRequest

Parameters:: pRequestScopeManager -
See Also:: DynamoHttpServletRequest.setRequestScopeManager(atg.nucleus.RequestScopeManager)

setRequestURI

public void setRequestURI(java.lang.String pRequestURI)

Description copied from class: MutableHttpServletRequest

Sets the RequestURI

Overrides:: setRequestURI in class MutableHttpServletRequest

Parameters:: pRequestURI -
See Also:: MutableHttpServletRequest.setRequestURI(java.lang.String)

setRequestURIHasQueryString

public void setRequestURIHasQueryString(boolean pRequestURIHasQueryString)

Description copied from class: DynamoHttpServletRequest

The servlet specification requires that the requestURI not contain query args. However, this property is provided to allow compatibility with older versions of Dynamo that returned the requestURI with query arguments. The default is "false," which will result in the behavior required by the specification.

Overrides:: setRequestURIHasQueryString in class DynamoHttpServletRequest

Parameters:: pRequestURIHasQueryString -
See Also:: DynamoHttpServletRequest.setRequestURIHasQueryString(boolean)

setResponse

public void setResponse(DynamoHttpServletResponse pResponse)

Description copied from class: DynamoHttpServletRequest

Sets the property Response. This gets set to refer to a particular response object that this request is associated with. It is here since the encodeURL method is part of the HttpServletResponse method in standard j2ee.

Overrides:: setResponse in class DynamoHttpServletRequest

Parameters:: pResponse -
See Also:: DynamoHttpServletRequest.setResponse(atg.servlet.DynamoHttpServletResponse)

setRestorableSessionIdFromURL

public void setRestorableSessionIdFromURL(java.lang.String pRestorableSessionIdFromURL)

Description copied from class: DynamoHttpServletRequest

Sets the session id taken from the URL which, if it differs from requestedSessionID indicates the need to restore a session. No relation to URLSessionIdSpecifier.

Overrides:: setRestorableSessionIdFromURL in class DynamoHttpServletRequest

Parameters:: pRestorableSessionIdFromURL -
See Also:: DynamoHttpServletRequest.setRestorableSessionIdFromURL(java.lang.String)

setScheme

public void setScheme(java.lang.String pScheme)

Description copied from class: MutableHttpServletRequest

Sets the Scheme

Overrides:: setScheme in class MutableHttpServletRequest

Parameters:: pScheme -
See Also:: MutableHttpServletRequest.setScheme(java.lang.String)

setScrambleKey

public void setScrambleKey(byte[] pScrambleKey)

Description copied from class: DynamoHttpServletRequest

Sets the Scramble Key property

Overrides:: setScrambleKey in class DynamoHttpServletRequest

Parameters:: pScrambleKey -
See Also:: DynamoHttpServletRequest.setScrambleKey(byte[])

setServerName

public void setServerName(java.lang.String pServerName)

Description copied from class: MutableHttpServletRequest

Sets the ServerName

Overrides:: setServerName in class MutableHttpServletRequest

Parameters:: pServerName -
See Also:: MutableHttpServletRequest.setServerName(java.lang.String)

setServerPort

public void setServerPort(int pServerPort)

Description copied from class: MutableHttpServletRequest

Sets the ServerPort

Overrides:: setServerPort in class MutableHttpServletRequest

Parameters:: pServerPort -
See Also:: MutableHttpServletRequest.setServerPort(int)

setServletPath

public void setServletPath(java.lang.String pServletPath)

Description copied from class: MutableHttpServletRequest

Sets the ServletPath

Overrides:: setServletPath in class MutableHttpServletRequest

Parameters:: pServletPath -
See Also:: MutableHttpServletRequest.setServletPath(java.lang.String)

setSessionRequest

public void setSessionRequest(HttpSessionRequest pSessionRequest)

Overrides:: setSessionRequest in class DynamoHttpServletRequest

Parameters:: pSessionRequest -
See Also:: DynamoHttpServletRequest.setSessionRequest(atg.servlet.HttpSessionRequest)

setupLoopbackTemplateEmailRequest

public void setupLoopbackTemplateEmailRequest()

Description copied from class: DynamoHttpServletRequest

Determines if this request is a loopback request made by the template email system, and if so, alters its state appropriately. In particular, this (1) disables the sending of page/session events, (2) disables exit tracking on this request, and (3) sets any template parameters specified in the TemplateEmailInfo.

Overrides:: setupLoopbackTemplateEmailRequest in class DynamoHttpServletRequest

See Also:: DynamoHttpServletRequest.setupLoopbackTemplateEmailRequest()

setURLSessionIdSpecifier

public void setURLSessionIdSpecifier(java.lang.String pURLSessionIdSpecifier)

Description copied from class: DynamoHttpServletRequest

Sets the URL Session ID Specifier

Overrides:: setURLSessionIdSpecifier in class DynamoHttpServletRequest

Parameters:: pURLSessionIdSpecifier -
See Also:: DynamoHttpServletRequest.setURLSessionIdSpecifier(java.lang.String)

setUserAuthenticator

public void setUserAuthenticator(UserAuthenticator pUserAuthenticator)

Description copied from class: DynamoHttpServletRequest

Sets the user authenticator to use if we are running in DAF

Overrides:: setUserAuthenticator in class DynamoHttpServletRequest

Parameters:: pUserAuthenticator -
See Also:: DynamoHttpServletRequest.setUserAuthenticator(atg.security.UserAuthenticator)

setWebApplication

public void setWebApplication(atg.servlet.minimal.WebApplicationInterface pWebApplication)

Description copied from class: DynamoHttpServletRequest

Set the J2EE WebApplicationInterface associated with this request. This method should only be called by Dynamo itself.

Overrides:: setWebApplication in class DynamoHttpServletRequest

Parameters:: pWebApplication -
See Also:: DynamoHttpServletRequest.setWebApplication(atg.servlet.minimal.WebApplicationInterface)

setWebPools

public void setWebPools(atg.servlet.WebPools pWebPools)

Description copied from class: DynamoHttpServletRequest

Set the WebPools object associated with this request. This method should only be called by Dynamo itself.

Overrides:: setWebPools in class DynamoHttpServletRequest

Parameters:: pWebPools -
See Also:: DynamoHttpServletRequest.setWebPools(atg.servlet.WebPools)

setWindowScopeManager

public void setWindowScopeManager(atg.nucleus.WindowScopeManager pScopeManager)

Description copied from class: DynamoHttpServletRequest

Sets the WindowScopeManager

Overrides:: setWindowScopeManager in class DynamoHttpServletRequest

Parameters:: pScopeManager -
See Also:: DynamoHttpServletRequest.setWindowScopeManager(atg.nucleus.WindowScopeManager)

setWrapper

public void setWrapper(javax.servlet.ServletRequestWrapper pWrapper)

Description copied from class: DynamoHttpServletRequest

Sets the ServletRequestWrapper wrapping this request. If there are multiple wrappers created in the course of executing the pipeline or filter chain this should be the outermost such wrapper.

Overrides:: setWrapper in class DynamoHttpServletRequest

Parameters:: pWrapper -
See Also:: DynamoHttpServletRequest.setWrapper(javax.servlet.ServletRequestWrapper)

shouldExitTrack

public boolean shouldExitTrack(java.lang.String pURL)

Description copied from class: DynamoHttpServletRequest

Returns true if the supplied URL should be exit tracked

Specified by:: shouldExitTrack in interface atg.servlet.exittracking.ExitTrackingHandler
Overrides:: shouldExitTrack in class DynamoHttpServletRequest

Parameters:: pURL -
Returns:
See Also:: DynamoHttpServletRequest.shouldExitTrack(java.lang.String)

tamperedURLParameters

public boolean tamperedURLParameters()

Description copied from class: DynamoHttpServletRequest

Returns true if the special Dynamo URL parameters could not be properly decoded.

Overrides:: tamperedURLParameters in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.tamperedURLParameters()

toString

public java.lang.String toString()

Description copied from class: DynamoHttpServletRequest

Return the string representation.

Overrides:: toString in class DynamoHttpServletRequest

Returns:
See Also:: DynamoHttpServletRequest.toString()

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

atg.servlet Class RestHttpServletRequestWrapper

CLASS_VERSION

RestHttpServletRequestWrapper

getRequest

setRequest

getParsedURI

setParsedURI

addPersistentQueryParameter

addQueryParameter

addURLParameter

encodeURL

encodeURL

encodeURL

encodeURL

encodeURL

encodeURL

endRequest

equals

getAttribute

getAttribute

getAttributeNames

getAuthType

getBaseDirectory

getBrowserTyper

getCharacterEncoding

getContentLength

getContentType

getContextPath

getCookieParameter

getCookieParameter

getCookieParameterCount

getCookieParameterNames

getCookieParameterValues

getCookies

getDateHeader

getDisableExitTracking

getDocRootServicePrefix

getEncodeContextPathMode

getEncodeServletPath

getEncodeURL

getEventFlags

getExitTrackingHandler

getExitTrackingParameterName

getFormEventsSent

getGenerateRequestLocales

getHeader

getHeaderNames

getHeaders

getInputStream

getIntHeader

getLinkEncoding

getLocalAddr

getLocale

getLocales

getLocalName

getLocalParameter

getLocalParameter

getLocalPort

getMapForCurrentFrame

getMethod

getMimeType

getMimeTyper

getNucleus

getObjectParameter

getObjectParameter

getObjectURLParameter

getParameter

getParameter

getParameterDelimiter

getParameterMap

getParameterNames

getParameterNamesInStack

getParameterValues

getParamMapForTopFrame

getPathInfo

getPathTranslated

getPermanentAttribute

getPostParameter

getPostParameter

getPostParameterCount

atg.servlet
Class RestHttpServletRequestWrapper