com.amazonaws.serverless.proxy.internal.servlet

Class AwsHttpServletRequest

java.lang.Object

com.amazonaws.serverless.proxy.internal.servlet.AwsHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

Direct Known Subclasses:

AwsProxyHttpServletRequest

public abstract class AwsHttpServletRequest
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest

Base HttpServletRequest object. This object exposes some utility methods to work with request values such as headers and query string parameters. New implementations of HttpServletRequest can extend this class to reuse the utility methods

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.DispatcherType	dispatcherType

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

Modifier and Type	Method and Description
java.lang.String	changeSessionId()
protected java.lang.String	decodeRequestPath(java.lang.String requestPath, ContainerConfig config)
protected java.lang.String	generateQueryString(java.util.Map<java.lang.String,java.lang.String> parameters, boolean encode, java.lang.String encodeCharset) Given a map of key/values query string parameters from API Gateway, creates a query string as it would have been in the original url.
javax.servlet.AsyncContext	getAsyncContext()
java.lang.Object	getAttribute(java.lang.String s)
java.util.Enumeration<java.lang.String>	getAttributeNames()
javax.servlet.DispatcherType	getDispatcherType()
java.lang.String	getLocalAddr()
java.lang.String	getLocalName()
int	getLocalPort()
java.lang.String	getRequestedSessionId()
java.lang.String	getServerName()
int	getServerPort()
javax.servlet.ServletContext	getServletContext()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSession	getSession(boolean b)
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl() Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
protected javax.servlet.http.Cookie[]	parseCookieHeaderValue(java.lang.String headerValue) Given the Cookie header value, parses it and creates a Cookie object
protected java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	parseHeaderValue(java.lang.String headerValue) Generic method to parse an HTTP header value and split it into a list of key/values for all its components.
void	removeAttribute(java.lang.String s)
void	setAttribute(java.lang.String s, java.lang.Object o)
void	setDispatcherType(javax.servlet.DispatcherType type)
void	setServletContext(javax.servlet.ServletContext context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.http.HttpServletRequest

authenticate, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestURI, getRequestURL, getServletPath, getUserPrincipal, isUserInRole, login, logout, upgrade

Methods inherited from interface javax.servlet.ServletRequest

getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getInputStream, getLocale, getLocales, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, isSecure, setCharacterEncoding, startAsync, startAsync

Field Detail

dispatcherType

protected javax.servlet.DispatcherType dispatcherType

Method Detail

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

getSession

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

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface javax.servlet.http.HttpServletRequest

changeSessionId

public java.lang.String changeSessionId()

Specified by:

changeSessionId in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest

getAttribute

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

Specified by:

getAttribute in interface javax.servlet.ServletRequest

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface javax.servlet.ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(java.lang.String s,
                         java.lang.Object o)

Specified by:

setAttribute in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(java.lang.String s)

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface javax.servlet.ServletRequest

getLocalAddr

public java.lang.String getLocalAddr()

Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface javax.servlet.ServletRequest

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.ServletRequest

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface javax.servlet.ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface javax.servlet.ServletRequest

getAsyncContext

public javax.servlet.AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface javax.servlet.ServletRequest

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface javax.servlet.ServletRequest

setDispatcherType

public void setDispatcherType(javax.servlet.DispatcherType type)

setServletContext

public void setServletContext(javax.servlet.ServletContext context)

parseCookieHeaderValue

protected javax.servlet.http.Cookie[] parseCookieHeaderValue(java.lang.String headerValue)

Given the Cookie header value, parses it and creates a Cookie object

Parameters:

headerValue - The string value of the HTTP Cookie header

Returns:

An array of Cookie objects from the header

generateQueryString

protected java.lang.String generateQueryString(java.util.Map<java.lang.String,java.lang.String> parameters,
                                               boolean encode,
                                               java.lang.String encodeCharset)
                                        throws javax.servlet.ServletException

Given a map of key/values query string parameters from API Gateway, creates a query string as it would have been in the original url.

Parameters:

parameters - A Map<String, String> of query string parameters

encode - Whether the key and values should be URL encoded

encodeCharset - Charset to use for encoding the query string

Returns:

The generated query string for the URI

Throws:

javax.servlet.ServletException

parseHeaderValue

protected java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> parseHeaderValue(java.lang.String headerValue)

Generic method to parse an HTTP header value and split it into a list of key/values for all its components. When the property in the header does not specify a key the key field in the output pair is null and only the value is populated. For example, The header Accept: application/json; application/xml will contain two key value pairs with key null and the value set to application/json and application/xml respectively.

Parameters:

headerValue - The string value for the HTTP header

Returns:

A list of SimpleMapEntry objects with all of the possible values for the header.

decodeRequestPath

protected java.lang.String decodeRequestPath(java.lang.String requestPath,
                                             ContainerConfig config)