Package javax.servlet.http

Interface HttpServletRequest

All Superinterfaces:

ServletRequest

All Known Subinterfaces:

WebApplicationRequest, WebApplicationServerRequest

All Known Implementing Classes:

DefaultWebApplicationRequest, DefaultWebApplicationServerRequest, EmbeddedRequest, HttpServletRequestWrapper, NanoRequest, RealtimeHttpServletRequestWrapper, WeldHttpServletRequest

public interface HttpServletRequest
extends ServletRequest

The HttpServletRequest API.

Author:

Manfred Riem ([email protected])

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASIC_AUTH	Defines the BASIC_AUTH constant.
static String	CLIENT_CERT_AUTH	Defines the CLIENT_CERT constant.
static String	DIGEST_AUTH	Defines the DIGEST constant.
static String	FORM_AUTH	Defines the FORM constant.

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(HttpServletResponse response)	Authenticate the request.
String	changeSessionId()	Change the session id.
String	getAuthType()	Get the auth type.
String	getContextPath()	Get the context path.
Cookie[]	getCookies()	Get the cookies.
long	getDateHeader(String name)	Get the date header.
String	getHeader(String name)	Get the header.
Enumeration<String>	getHeaderNames()	Get the header names.
Enumeration<String>	getHeaders(String name)	Get the headers.
default HttpServletMapping	getHttpServletMapping()	Get the HTTP servlet mapping.
int	getIntHeader(String name)	Get the int header.
String	getMethod()	Get the HTTP method.
Part	getPart(String name)	Get the part.
Collection<Part>	getParts()	Get the parts.
String	getPathInfo()	Get the path info.
String	getPathTranslated()	Get the path translated.
String	getQueryString()	Get the query string.
String	getRemoteUser()	Get the remote user.
String	getRequestedSessionId()	Get the requested session id.
String	getRequestURI()	Get the request URI.
StringBuffer	getRequestURL()	Get the request URL.
String	getServletPath()	Get the servlet path.
HttpSession	getSession()	Get the HTTP session.
HttpSession	getSession(boolean create)	Get the HTTP session.
default Map<String,String>	getTrailerFields()	Get the trailer fields.
Principal	getUserPrincipal()	Get the user principal.
boolean	isRequestedSessionIdFromCookie()	Is the requested session id from a cookie.
boolean	isRequestedSessionIdFromUrl()	Deprecated.
boolean	isRequestedSessionIdFromURL()	Is the requested session id from a URL.
boolean	isRequestedSessionIdValid()	Is the requested session id valid.
default boolean	isTrailerFieldsReady()	Is trailer fields ready.
boolean	isUserInRole(String role)	Is the user in the specified role.
void	login(String username, String password)	Login.
void	logout()	Logout.
default PushBuilder	newPushBuilder()	Create a new push builder.
<T extends HttpUpgradeHandler> T	upgrade(Class<T> handlerClass)	Upgrade the request.

Methods inherited from interface javax.servlet.ServletRequest

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

Field Detail

BASIC_AUTH

static final String BASIC_AUTH

Defines the BASIC_AUTH constant.

See Also:

Constant Field Values

CLIENT_CERT_AUTH

static final String CLIENT_CERT_AUTH

Defines the CLIENT_CERT constant.

See Also:

Constant Field Values

DIGEST_AUTH

static final String DIGEST_AUTH

Defines the DIGEST constant.

See Also:

Constant Field Values

FORM_AUTH

static final String FORM_AUTH

Defines the FORM constant.

See Also:

Constant Field Values

Method Detail

authenticate

boolean authenticate(HttpServletResponse response)
              throws IOException,
                     ServletException

Authenticate the request.

Parameters:

response - the response.

Returns:

true if authenticated, false otherwise.

Throws:

IOException - when an I/O error occurs.

ServletException - when a Servlet error occurs.

changeSessionId

String changeSessionId()

Change the session id.

Returns:

the new session id.

getAuthType

String getAuthType()

Get the auth type.

Returns:

the auth type.

getContextPath

String getContextPath()

Get the context path.

Returns:

the context path.

getCookies

Cookie[] getCookies()

Get the cookies.

Returns:

the cookies, or null if none.

getDateHeader

long getDateHeader(String name)

Get the date header.

Parameters:

name - the name.

Returns:

the date, or -1 if not found.

getHeader

String getHeader(String name)

Get the header.

Parameters:

name - the name.

Returns:

the header, or null if not found.

getHeaders

Enumeration<String> getHeaders(String name)

Get the headers.

Parameters:

name - the name.

Returns:

the headers.

getHeaderNames

Enumeration<String> getHeaderNames()

Get the header names.

Returns:

the header names.

getHttpServletMapping

default HttpServletMapping getHttpServletMapping()

Get the HTTP servlet mapping.

Returns:

the HTTP servlet mapping.

getIntHeader

int getIntHeader(String name)

Get the int header.

Parameters:

name - the name.

Returns:

the header, or -1 if not found.

getMethod

String getMethod()

Get the HTTP method.

Returns:

the HTTP method.

getPart

Part getPart(String name)
      throws IOException,
             ServletException

Get the part.

Parameters:

name - the name.

Returns:

the part, or null if not found.

Throws:

IOException - when an I/O error occurs.

ServletException - when a Servlet error occurs.

getParts

Collection<Part> getParts()
                   throws IOException,
                          ServletException

Get the parts.

Returns:

the parts.

Throws:

IOException - when an I/O error occurs.

ServletException - when a Servlet error occurs.

getPathInfo

String getPathInfo()

Get the path info.

Returns:

the path info.

getPathTranslated

String getPathTranslated()

Get the path translated.

Returns:

the path translated.

getQueryString

String getQueryString()

Get the query string.

Returns:

the query string, or null if not found.

getRemoteUser

String getRemoteUser()

Get the remote user.

Returns:

the remote user, or null if not found.

getRequestURI

String getRequestURI()

Get the request URI.

Returns:

the request URI.

getRequestURL

StringBuffer getRequestURL()

Get the request URL.

Returns:

the request URL.

getRequestedSessionId

String getRequestedSessionId()

Get the requested session id.

Returns:

the requested session id.

getServletPath

String getServletPath()

Get the servlet path.

Returns:

the servlet path.

getSession

HttpSession getSession(boolean create)

Get the HTTP session.

Parameters:

create - the create flag.

Returns:

the HTTP session, or null if not found and create flag is false.

getSession

HttpSession getSession()

Get the HTTP session.

Returns:

the HTTP session.

getTrailerFields

default Map<String,String> getTrailerFields()

Get the trailer fields.

Returns:

the trailer fields.

getUserPrincipal

Principal getUserPrincipal()

Get the user principal.

Returns:

the user principal.

isRequestedSessionIdFromCookie

boolean isRequestedSessionIdFromCookie()

Is the requested session id from a cookie.

Returns:

true if it is, false otherwise.

isRequestedSessionIdFromURL

boolean isRequestedSessionIdFromURL()

Is the requested session id from a URL.

Returns:

true if it is, false otherwise.

isRequestedSessionIdFromUrl

@Deprecated
boolean isRequestedSessionIdFromUrl()

Deprecated.

Is the requested session id from a URL.

Returns:

true if it is, false otherwise.

isRequestedSessionIdValid

boolean isRequestedSessionIdValid()

Is the requested session id valid.

Returns:

true if it is, false otherwise.

isTrailerFieldsReady

default boolean isTrailerFieldsReady()

Is trailer fields ready.

Returns:

true if fields are ready, false otherwise.

isUserInRole

boolean isUserInRole(String role)

Is the user in the specified role.

Parameters:

role - the role.

Returns:

true if the user is in the specified role, false otherwise.

login

void login(String username,
           String password)
    throws ServletException

Login.

Parameters:

username - the username.

password - the password.

Throws:

ServletException - when a Servlet error occurs.

logout

void logout()
     throws ServletException

Logout.

Throws:

ServletException - when a Servlet error occurs.

newPushBuilder

default PushBuilder newPushBuilder()

Create a new push builder.

Returns:

the push builder.

upgrade

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

Upgrade the request.

Type Parameters:

T - the type of HTTP upgrade handler.

Parameters:

handlerClass - the handler class.

Returns:

the HTTP upgrade handler.

Throws:

IOException - when an I/O error occurs.

ServletException - when a Servlet error occurs.