atg.servlet

Class RestHttpServletRequestWrapper

java.lang.Object

atg.servlet.MutableHttpServletRequest

atg.servlet.DynamoHttpServletRequest

atg.servlet.wrappers.DynamoHttpServletRequestWrapper

atg.servlet.RestHttpServletRequestWrapper

All Implemented Interfaces:

atg.core.logging.Logging, NameResolver, ApplicationLogging, atg.servlet.exittracking.ExitTrackingHandler, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class RestHttpServletRequestWrapper
extends atg.servlet.wrappers.DynamoHttpServletRequestWrapper

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Fields inherited from class atg.servlet.DynamoHttpServletRequest

ATTRIBUTE_NAME, CERTIFICATES_ATTRIBUTE, CIPHER_SUITE_ATTR, COOKIE_ATTRIBUTE_NAME, 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_ARGUMENT_ATTRIBUTE_NAME, 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

Constructors

Constructor and Description
RestHttpServletRequestWrapper(DynamoHttpServletRequest pRequest, BeanURI pParsedURI) Constructor

Method Summary

Modifier and Type	Method and Description
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.String	getParameter(java.lang.String pName) Intercepts the getParameter call to the underlying request and substitutes parameters from the REST request.
BeanURI	getParsedURI() The ParsedURI for this request
DynamoHttpServletRequest	getRequest() returns the wrapped request
void	setParsedURI(BeanURI pParsedURI) Sets the ParsedURI for this request
void	setRequest(DynamoHttpServletRequest pRequest) Sets the wrapped request

Methods inherited from class atg.servlet.wrappers.DynamoHttpServletRequestWrapper

addPersistentQueryParameter, addQueryParameter, addURLParameter, encodeURL, encodeURL, encodeURL, encodeURL, encodeURL, encodeURL, encodeURL, encodeURL, endRequest, equals, getAttribute, getAttribute, getAttributeNames, getAuthType, getBaseDirectory, getBrowserTyper, getCharacterEncoding, getContentLength, getContentType, getContextNamePath, getContextPath, getCookieParameter, getCookieParameter, getCookieParameterCount, getCookieParameterNames, getCookieParameterValues, getCookies, getCountOfFrames, getCurrentFrameWithoutNulls, getDateHeader, getDisableExitTracking, getDocRootServicePrefix, getEncodeContextPathMode, getEncodeServletPath, getEncodeURL, getEventFlags, getExitTrackingHandler, getExitTrackingParameterName, getFormEventsSent, getGenerateRequestLocales, getHeader, getHeaderNames, getHeaders, getInputStream, getIntHeader, getLinkEncoding, getLocalAddr, getLocale, getLocales, getLocalName, getLocalParameter, getLocalParameter, getLocalPort, getLog, getMapCopyOfCurrentFrame, getMapForCurrentFrame, getMethod, getMimeType, getMimeTyper, getMultiNucleusNameResolverFactory, getMultiNucleusResolveNameHelper, getNameResolverFactory, getNucleus, getObjectParameter, getObjectURLParameter, getParameter, getParameterDelimiter, getParameterMap, getParameterNames, getParameterNamesInStack, getParameterValues, getParamMapForTopFrame, getPathInfo, getPathTranslated, getPermanentAttribute, getPostParameter, getPostParameter, getPostParameterCount, getPostParameterNames, getPostParameterValues, getProtocol, getQueryParameter, getQueryParameter, getQueryParameterCount, getQueryParameterNames, getQueryParameterValues, getQueryString, getReader, getRealPath, getRedirectURLValidator, getRemoteAddr, getRemoteHost, getRemotePort, getRemoteUser, getRequestDispatcher, getRequestDispatcher, getRequestedSessionId, getRequestForComparison, getRequestLocale, getRequestLocalePath, getRequestScope, getRequestScopeManager, getRequestURI, getRequestURIWithQueryString, getRequestURL, getResolveNameHelper, getResponse, getRestorableSessionIdFromURL, getScheme, getScrambleKey, getServerName, getServerPort, getServletPath, getSession, getSession, getSessionConfirmationNumber, getSessionNameContext, getSessionRequest, getSessionRequest, getURLParameter, getURLParameter, getURLParameterCount, getURLParameterNames, getURLParameterString, getURLParameterValues, getURLSessionIdSpecifier, getUserAuthenticator, getUserPrincipal, getWebApplication, getWindowScope, getWindowScopeManager, getWorkingDirectory, getWrappedRequest, getWrapper, hashCode, hasRequestScope, isAfterGetsClaimed, isBrowserType, isDelayedRequest, isDynamoPipeline, isInitialized, isInTemplatePage, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isRequestURISet, isSecure, isUserInRole, isUseXmlParamDelimiter, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, performExitTracking, popDefaultParameters, popFrame, popParameters, printRequest, pushDefaultParameters, pushFrame, pushParameters, removeAttribute, removeParameter, removePersistentQueryParameter, removeSessionFromRequest, resolveGlobalName, resolveGlobalName, resolveName, resolveName, resolveName, resolveName, resolveRequestName, resolveRequestName, resolveSessionName, resolveSessionName, reverseMapContextRootForLayering, serviceLocalParameter, serviceLocalParameter, serviceParameter, serviceParameter, serviceParameter, serviceParameter, setAfterGetsClaimed, setAttribute, setAttributeFactory, setAuthType, setBaseDirectory, setBrowserTyper, setCharacterEncoding, setContentLength, setContentType, setContextPath, setDisableExitTracking, setDocRootServicePrefix, setDynamoPipeline, setEncodeContextPathMode, setEncodeServletPath, setEncodeURL, setEventFlags, setExitTrackingHandler, setFormEventsSent, setGenerateRequestLocales, setInitialized, setInputStream, setInTemplatePage, setLinkEncoding, setLog, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingWarning, setMethod, setMimeType, setMimeTyper, setMultiNucleusNameResolverFactory, setNameResolverFactory, setNucleus, setParameter, setParameter, setParameterDelimiter, setParameterHandler, setPathInfo, setPathTranslated, setProtocol, setQueryString, setRedirectURLValidator, setRemoteAddr, setRemoteHost, setRemoteUser, setRequest, setRequestLocale, setRequestLocalePath, setRequestScope, setRequestScopeManager, setRequestURI, setRequestURIHasQueryString, setResolveNameHelper, setResponse, setRestorableSessionIdFromURL, setScheme, setScrambleKey, setServerName, setServerPort, setServletPath, setSessionRequest, setupLoopbackTemplateEmailRequest, setURLSessionIdSpecifier, setUserAuthenticator, setUseXmlParamDelimiter, setWebApplication, setWindowScopeManager, setWrappedRequest, setWrapper, shouldExitTrack, tamperedURLParameters, toString

Methods inherited from class atg.servlet.DynamoHttpServletRequest

getNullParameterObject, 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 atg.servlet.wrappers.DynamoHttpServletRequestWrapper

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

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 atg.servlet.wrappers.DynamoHttpServletRequestWrapper

Parameters:

pName - the parameter name

Returns:

the value of the property

See Also:

DynamoHttpServletRequestWrapper.getObjectParameter(java.lang.String)

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 atg.servlet.wrappers.DynamoHttpServletRequestWrapper

Parameters:

pName - the parameter name

Returns:

the string value of the property

See Also:

DynamoHttpServletRequestWrapper.getParameter(java.lang.String)