net.officefloor.plugin.servlet.container

Class HttpServletRequestImpl

java.lang.Object

net.officefloor.plugin.servlet.container.HttpServletRequestImpl

All Implemented Interfaces:

HttpServletRequest, ServletRequest, ServletRequestForwarder

public class HttpServletRequestImpl
extends Object
implements HttpServletRequest, ServletRequestForwarder

HttpServletRequest implementation.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	RFC1123_HEADER_DATE_FORMAT RFC 1123 header date format.

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Fields inherited from interface net.officefloor.plugin.servlet.container.ServletRequestForwarder

ATTRIBUTE_FORWARDER

Constructor Summary

Constructors

Constructor and Description
HttpServletRequestImpl(net.officefloor.plugin.socket.server.http.ServerHttpConnection connection, HttpRequestState requestAttributes, HttpServletSecurity security, String sessionIdIdentifierName, HttpSession session, ServletContext servletContext, Locale defaultLocale, net.officefloor.frame.api.execute.TaskContext<?,?,?> taskContext) Initiate.

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(HttpServletResponse arg0)
String	changeSessionId()
void	forward(String workName, String taskName, Object parameter) Forwards the ServletRequest.
AsyncContext	getAsyncContext()
Object	getAttribute(String name)
Enumeration	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	getHeaderNames()
Enumeration	getHeaders(String name)
ServletInputStream	getInputStream()
int	getIntHeader(String name)
String	getLocalAddr()
Locale	getLocale()
Enumeration	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String name)
Map	getParameterMap()
Enumeration	getParameterNames()
String[]	getParameterValues(String name)
Part	getPart(String arg0)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String path)
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()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String role)
void	login(String arg0, String arg1)
void	logout()
void	removeAttribute(String name)
void	setAttribute(String name, Object object)
void	setCharacterEncoding(String env)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest arg0, ServletResponse arg1)
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)

Methods inherited from class java.lang.Object

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

Field Detail

RFC1123_HEADER_DATE_FORMAT

public static final String RFC1123_HEADER_DATE_FORMAT

RFC 1123 header date format.

See Also:

Constant Field Values

Constructor Detail

HttpServletRequestImpl

public HttpServletRequestImpl(net.officefloor.plugin.socket.server.http.ServerHttpConnection connection,
                              HttpRequestState requestAttributes,
                              HttpServletSecurity security,
                              String sessionIdIdentifierName,
                              HttpSession session,
                              ServletContext servletContext,
                              Locale defaultLocale,
                              net.officefloor.frame.api.execute.TaskContext<?,?,?> taskContext)
                       throws IOException,
                              HttpRequestTokeniseException

Initiate.

Parameters:

connection - ServerHttpConnection.

requestAttributes - HttpRequestState.

security - HttpServletSecurity.

sessionIdIdentifierName - Name of identifier (e.g. cookie or parameter name) providing the session Id.

session - HttpSession.

servletContext - ServletContext.

defaultLocale - Default Locale if not specified.

taskContext - TaskContext.

Throws:

IOException - If fails to read data from the HttpRequest.

HttpRequestTokeniseException - If fails to tokenise the HttpRequest.

Method Detail

forward

public void forward(String workName,
                    String taskName,
                    Object parameter)
             throws ServletException

Description copied from interface: ServletRequestForwarder

Forwards the ServletRequest.

Specified by:

forward in interface ServletRequestForwarder

Parameters:

workName - Name of Work to forward the ServletRequest.

taskName - Name of Task on the Work to forward the ServletRequest.

parameter - Parameter for the Task.

Throws:

ServletException - If fails to forward the ServletRequest.

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

getParameterMap

public Map getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

getParameterNames

public Enumeration getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Throws:

IOException

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletRequest

getHeaderNames

public Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getHeaders

public Enumeration getHeaders(String name)

Specified by:

getHeaders in interface HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface HttpServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface ServletRequest

getAttributeNames

public Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

setAttribute

public void setAttribute(String name,
                         Object object)

Specified by:

setAttribute in interface ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String env)
                          throws UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface ServletRequest

Throws:

UnsupportedEncodingException

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

getLocales

public Enumeration getLocales()

Specified by:

getLocales in interface ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface HttpServletRequest

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface ServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

getDispatcherType

public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest

getServletContext

public ServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

startAsync

public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

startAsync

public AsyncContext startAsync(ServletRequest arg0,
                               ServletResponse arg1)
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

authenticate

public boolean authenticate(HttpServletResponse arg0)
                     throws IOException,
                            ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

public Part getPart(String arg0)
             throws IOException,
                    ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

getParts

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

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

login

public void login(String arg0,
                  String arg1)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

upgrade

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

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException