com.adobe.forms.common.submitutils

Class CustomParameterRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper

com.adobe.forms.common.submitutils.CustomParameterRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest, Adaptable, SlingHttpServletRequest

public class CustomParameterRequest
extends SlingHttpServletRequestWrapper

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
CustomParameterRequest(SlingHttpServletRequest request, ParameterMap params, java.lang.String method)
CustomParameterRequest(SlingHttpServletRequest request, java.lang.String method)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
RequestParameter	getRequestParameter(java.lang.String name) Returns the value of a request parameter as a RequestParameter, or null if the parameter does not exist.
RequestParameterMap	getRequestParameterMap() Returns a Map of the parameters of this request.
RequestParameter[]	getRequestParameters(java.lang.String name) Returns an array of RequestParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.

Methods inherited from class org.apache.sling.api.wrappers.SlingHttpServletRequestWrapper

adaptTo, getCookie, getRequestDispatcher, getRequestDispatcher, getRequestDispatcher, getRequestParameterList, getRequestPathInfo, getRequestProgressTracker, getResource, getResourceBundle, getResourceBundle, getResourceResolver, getResponseContentType, getResponseContentTypes, getSlingRequest

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from class javax.servlet.ServletRequestWrapper

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, isWrapperFor, isWrapperFor, removeAttribute, setAttribute, setCharacterEncoding, setRequest, startAsync, startAsync

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.http.HttpServletRequest

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Constructor Detail

CustomParameterRequest

public CustomParameterRequest(SlingHttpServletRequest request,
                              ParameterMap params,
                              java.lang.String method)

CustomParameterRequest

public CustomParameterRequest(SlingHttpServletRequest request,
                              java.lang.String method)

Method Detail

getRequestParameter

public RequestParameter getRequestParameter(java.lang.String name)

Description copied from interface: SlingHttpServletRequest

Returns the value of a request parameter as a RequestParameter, or null if the parameter does not exist.

This method should only be used if the parameter has only one value. If the parameter might have more than one value, use SlingHttpServletRequest.getRequestParameters(String).

If this method is used with a multivalued parameter, the value returned is equal to the first value in the array returned by getRequestParameters.

This method is a shortcut for getRequestParameterMap().getValue(String).

Specified by:

getRequestParameter in interface SlingHttpServletRequest

Overrides:

getRequestParameter in class SlingHttpServletRequestWrapper

Parameters:

name - a String specifying the name of the parameter

Returns:

a RequestParameter representing the single value of the parameter

See Also:

SlingHttpServletRequest.getRequestParameters(String), RequestParameterMap.getValue(String)

getRequestParameterMap

public RequestParameterMap getRequestParameterMap()

Description copied from interface: SlingHttpServletRequest

Returns a Map of the parameters of this request.

The values in the returned Map are from type RequestParameter array (RequestParameter[]).

If no parameters exist this method returns an empty Map.

Specified by:

getRequestParameterMap in interface SlingHttpServletRequest

Overrides:

getRequestParameterMap in class SlingHttpServletRequestWrapper

Returns:

an immutable Map containing parameter names as keys and parameter values as map values, or an empty Map if no parameters exist. The keys in the parameter map are of type String. The values in the parameter map are of type RequestParameter array (RequestParameter[]).

getRequestParameters

public RequestParameter[] getRequestParameters(java.lang.String name)

Description copied from interface: SlingHttpServletRequest

Returns an array of RequestParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.

If the parameter has a single value, the array has a length of 1.

This method is a shortcut for getRequestParameterMap().getValues(String).

Specified by:

getRequestParameters in interface SlingHttpServletRequest

Overrides:

getRequestParameters in class SlingHttpServletRequestWrapper

Parameters:

name - a String containing the name of the parameter the value of which is requested

Returns:

an array of RequestParameter objects containing the parameter values.

See Also:

SlingHttpServletRequest.getRequestParameter(String), RequestParameterMap.getValues(String)

getParameter

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

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

getParameterMap

public java.util.Map getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class ServletRequestWrapper

getParameterNames

public java.util.Enumeration getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

getParameterValues

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

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface HttpServletRequest

Overrides:

getMethod in class HttpServletRequestWrapper