Class SokletHttpServletRequest

java.lang.Object

com.soklet.servlet.javax.SokletHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

@NotThreadSafe
public final class SokletHttpServletRequest
extends Object
implements HttpServletRequest

Soklet integration implementation of HttpServletRequest.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SokletHttpServletRequest.Builder	Builder used to construct instances of SokletHttpServletRequest.

Field Summary

Fields inherited from interface HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse httpServletResponse)
String	changeSessionId()
AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration<String>	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
DispatcherType	getDispatcherType()
String	getHeader(String name)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String name)
ServletInputStream	getInputStream()
int	getIntHeader(String name)
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
Part	getPart(String name)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String path)	Deprecated.
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
ServletContext	getServletContext()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String role)
void	login(String username, String password)
void	logout()
void	removeAttribute(String name)
void	setAttribute(String name, Object o)
void	setCharacterEncoding(String env)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)
static SokletHttpServletRequest.Builder	withRequest(Request request)

Methods inherited from class Object

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

Methods inherited from interface HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Method Details

withRequest

@Nonnull
public static SokletHttpServletRequest.Builder withRequest(@Nonnull
 Request request)

getAuthType

@Nullable
public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getCookies

@Nonnull
public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(@Nullable
 String name)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

@Nullable
public String getHeader(@Nullable
 String name)

Specified by:

getHeader in interface HttpServletRequest

getHeaders

@Nonnull
public Enumeration<String> getHeaders(@Nullable
 String name)

Specified by:

getHeaders in interface HttpServletRequest

getHeaderNames

@Nonnull
public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getIntHeader

public int getIntHeader(@Nullable
 String name)

Specified by:

getIntHeader in interface HttpServletRequest

getMethod

@Nonnull
public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

getPathInfo

@Nullable
public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

@Nullable
public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getContextPath

@Nonnull
public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getQueryString

@Nullable
public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRemoteUser

@Nullable
public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(@Nullable
 String role)

Specified by:

isUserInRole in interface HttpServletRequest

getUserPrincipal

@Nullable
public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

getRequestedSessionId

@Nullable
public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURI

@Nonnull
public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

@Nonnull
public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getServletPath

@Nonnull
public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getSession

@Nullable
public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getSession

@Nonnull
public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

changeSessionId

@Nonnull
public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

authenticate

public boolean authenticate(@Nonnull
 HttpServletResponse httpServletResponse)
                     throws IOException,
ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

login

public void login(@Nullable
 String username,
 @Nullable
 String password)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

getParts

@Nonnull
public Collection<Part> getParts()
                          throws IOException,
ServletException

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

@Nullable
public Part getPart(@Nullable
 String name)
             throws IOException,
ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

upgrade

@Nonnull
public <T extends HttpUpgradeHandler> T upgrade(@Nullable
 Class<T> handlerClass)
                                         throws IOException,
ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException

getAttribute

@Nullable
public Object getAttribute(@Nullable
 String name)

Specified by:

getAttribute in interface ServletRequest

getAttributeNames

@Nonnull
public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

getCharacterEncoding

@Nonnull
public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(@Nullable
 String env)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Throws:

UnsupportedEncodingException

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

getContentType

@Nullable
public String getContentType()

Specified by:

getContentType in interface ServletRequest

getInputStream

@Nonnull
public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Throws:

IOException

getParameter

@Nullable
public String getParameter(@Nullable
 String name)

Specified by:

getParameter in interface ServletRequest

getParameterNames

@Nonnull
public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

getParameterValues

@Nullable
public String[] getParameterValues(@Nullable
 String name)

Specified by:

getParameterValues in interface ServletRequest

getParameterMap

@Nonnull
public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

getProtocol

@Nonnull
public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getScheme

@Nonnull
public String getScheme()

Specified by:

getScheme in interface ServletRequest

getServerName

@Nonnull
public String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

getReader

@Nonnull
public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

getRemoteAddr

@Nullable
public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

@Nullable
public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

setAttribute

public void setAttribute(@Nullable
 String name,
 @Nullable
 Object o)

Specified by:

setAttribute in interface ServletRequest

removeAttribute

public void removeAttribute(@Nullable
 String name)

Specified by:

removeAttribute in interface ServletRequest

getLocale

@Nonnull
public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

getLocales

@Nonnull
public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

getRequestDispatcher

@Nullable
public RequestDispatcher getRequestDispatcher(@Nullable
 String path)

Specified by:

getRequestDispatcher in interface ServletRequest

getRealPath

@Deprecated
@Nullable
public String getRealPath(String path)

Deprecated.

Specified by:

getRealPath in interface ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

getLocalName

@Nonnull
public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

getLocalAddr

@Nonnull
public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

getServletContext

@Nonnull
public ServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

startAsync

@Nonnull
public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

startAsync

@Nonnull
public AsyncContext startAsync(@Nonnull
 ServletRequest servletRequest,
 @Nonnull
 ServletResponse servletResponse)
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

getAsyncContext

@Nonnull
public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

getDispatcherType

@Nonnull
public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest