Class Request
- java.lang.Object
-
- org.apache.catalina.connector.Request
-
- All Implemented Interfaces:
HttpServletRequest,ServletRequest
public class Request extends Object implements HttpServletRequest
Wrapper object for the Coyote request.- Author:
- Remy Maucherat, Craig R. McClanahan
-
-
Field Summary
Fields Modifier and Type Field Description protected BooleanasyncSupportedprotected StringauthTypeAuthentication type.protected static intCACHED_POST_LENPost data buffer.protected ConnectorconnectorAssociated Catalina connector.protected Cookie[]cookiesThe set of cookies associated with this Request.protected booleancookiesConvertedCookie parsed flag.protected booleancookiesParsedCookie headers parsed flag.protected RequestcoyoteRequestCoyote request.protected static LocaledefaultLocaleThe default Locale if none are specified.protected RequestFacadefacadeThe facade associated with this request.protected FilterChainfilterChainFilter chain associated with the request.protected InputBufferinputBufferThe associated input buffer.protected CoyoteInputStreaminputStreamServletInputStream.protected DispatcherTypeinternalDispatcherTypeThe current dispatcher type.protected StringlocalAddrLocal addressprotected ArrayList<Locale>localesThe preferred Locales associated with this Request.protected booleanlocalesParsedParse locales.protected StringlocalNameLocal addressprotected intlocalPortLocal portprotected MappingDatamappingDataMapping data.protected ParameterMap<String,String[]>parameterMapHash map used in the getParametersMap method.protected booleanparametersParsedRequest parameters parsed flag.protected Collection<Part>partsThe parts, if any, uploaded with this request.protected ExceptionpartsParseExceptionThe exception thrown, if any when parsing the parts.protected StringpeerAddrConnection peer address.protected byte[]postDataprotected CoyoteReaderreaderReader.protected StringremoteAddrRemote address.protected StringremoteHostRemote host.protected intremotePortRemote portprotected ObjectrequestDispatcherPathThe current request dispatcher path.protected booleanrequestedSessionCookieWas the requested session ID received in a cookie?protected StringrequestedSessionIdThe requested session ID (if any) for this request.protected booleanrequestedSessionSSLWas the requested session ID obtained from the SSL session?protected booleanrequestedSessionURLWas the requested session ID received in a URL?protected ResponseresponseThe response with which this request is associated.protected booleansecureSecure flag.protected SessionsessionThe currently active session for this request.protected static StringManagersmThe string manager for this package.protected booleansslAttributesParsedFlag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().protected SubjectsubjectThe Subject associated with the current AccessControlContextprotected B2CConverterURIConverterURI byte to char converter.protected PrincipaluserPrincipalUser principal.protected booleanusingInputStreamUsing stream flag.protected booleanusingReaderUsing reader flag.-
Fields inherited from interface jakarta.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCookie(Cookie cookie)Add a Cookie to the set of Cookies associated with this Request.voidaddLocale(Locale locale)Add a Locale to the set of preferred Locales for this Request.protected voidaddPathParameter(String name, String value)booleanauthenticate(HttpServletResponse response)Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.StringchangeSessionId()Changes the session ID of the session associated with this request.voidchangeSessionId(String newSessionId)Change the ID of the session that this request is associated with.protected voidcheckSwallowInput()Check the configuration for aborted uploads and if configured to do so, disable the swallowing of any remaining input and close the connection once the response has been written.voidclearCookies()Clear the collection of Cookies associated with this Request.voidclearLocales()Clear the collection of Locales associated with this Request.protected voidconvertCookies()Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.ServletInputStreamcreateInputStream()Create and return a ServletInputStream to read the content associated with this Request.protected SessiondoGetSession(boolean create)voidfinishRequest()Perform whatever actions are required to flush and close the input stream or reader, in a single operation.AsyncContextgetAsyncContext()Get the current AsyncContext.AsyncContextImplgetAsyncContextInternal()ObjectgetAttribute(String name)Returns the value of the named attribute as anObject, ornullif no attribute of the given name exists.Enumeration<String>getAttributeNames()Return the names of all request attributes for this Request, or an emptyEnumerationif there are none.StringgetAuthType()Return the authentication type used for this Request.StringgetCharacterEncoding()Returns the name of the character encoding used in the body of this request.ConnectorgetConnector()intgetContentLength()Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.longgetContentLengthLong()Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.StringgetContentType()Returns the MIME type of the body of the request, ornullif the type is not known.ContextgetContext()Return the Context within which this Request is being processed.StringgetContextPath()Return the portion of the request URI used to select the Context of the Request.Cookie[]getCookies()Return the set of Cookies received with this Request.RequestgetCoyoteRequest()Get the Coyote request.longgetDateHeader(String name)Return the value of the specified date header, if any; otherwise return -1.StringgetDecodedRequestURI()Get the decoded request URI.MessageBytesgetDecodedRequestURIMB()Get the decoded request URI.booleangetDiscardFacades()Get the recycling strategy of the facade objects.DispatcherTypegetDispatcherType()FilterChaingetFilterChain()Get filter chain associated with the request.StringgetHeader(String name)Return the first value of the specified header, if any; otherwise, returnnullEnumeration<String>getHeaderNames()Returns an enumeration of all the header names this request contains.Enumeration<String>getHeaders(String name)Return all of the values of the specified header, if any; otherwise, return an empty enumeration.HostgetHost()HttpServletMappinggetHttpServletMapping()Obtain the mapping information for this request.ServletInputStreamgetInputStream()Retrieves the body of the request as binary data using aServletInputStream.intgetIntHeader(String name)Return the value of the specified header as an integer, or -1 if there is no such header for this request.StringgetLocalAddr()Returns the Internet Protocol (IP) address of the interface on which the request was received.LocalegetLocale()Returns the preferredLocalethat the client will accept content in, based on the Accept-Language header.Enumeration<Locale>getLocales()Returns anEnumerationofLocaleobjects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.StringgetLocalName()Returns the host name of the Internet Protocol (IP) interface on which the request was received.intgetLocalPort()Returns the Internet Protocol (IP) port number of the interface on which the request was received.MappingDatagetMappingData()StringgetMethod()Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.ObjectgetNote(String name)StringgetParameter(String name)Returns the value of a request parameter as aString, ornullif the parameter does not exist.Map<String,String[]>getParameterMap()Returns aMapof the parameters of this request.Enumeration<String>getParameterNames()Returns anEnumerationofStringobjects containing the names of the parameters contained in this request.String[]getParameterValues(String name)Returns an array ofStringobjects containing all of the values the given request parameter has, ornullif the parameter does not exist.PartgetPart(String name)Gets the named Part or null if the Part does not exist.Collection<Part>getParts()Return a collection of all uploaded Parts.StringgetPathInfo()Returns any extra path information associated with the URL the client sent when it made this request.protected StringgetPathParameter(String name)StringgetPathTranslated()Returns any extra path information after the servlet name but before the query string, and translates it to a real path.StringgetPeerAddr()PrincipalgetPrincipal()StringgetProtocol()Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.StringgetProtocolRequestId()Obtain the request identifier for this request as defined by the protocol in use.StringgetQueryString()Returns the query string that is contained in the request URL after the path.BufferedReadergetReader()Read the Reader wrapping the input stream for this Request.StringgetRemoteAddr()Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.StringgetRemoteHost()Returns the fully qualified name of the client or the last proxy that sent the request.intgetRemotePort()Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.StringgetRemoteUser()Returns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated.HttpServletRequestgetRequest()RequestDispatchergetRequestDispatcher(String path)Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path.StringgetRequestedSessionId()Returns the session ID specified by the client.StringgetRequestId()Obtain a unique (within the lifetime of the Servlet container) identifier string for this request.MessageBytesgetRequestPathMB()Get the request path.StringgetRequestURI()Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.StringBuffergetRequestURL()Reconstructs the URL the client used to make the request.ResponsegetResponse()StringgetScheme()Returns the name of the scheme used to make this request, for example,http,https, orftp.ServerCookiesgetServerCookies()Return the server representation of the cookies associated with this request.StringgetServerName()Returns the host name of the server to which the request was sent.intgetServerPort()Returns the port number to which the request was sent.ServletConnectiongetServletConnection()Obtain details of the network connection to the Servlet container that is being used by this request.ServletContextgetServletContext()StringgetServletPath()Returns the part of this request's URL that calls the servlet.HttpSessiongetSession()Returns the current session associated with this request, or if the request does not have a session, creates one.HttpSessiongetSession(boolean create)Returns the currentHttpSessionassociated with this request or, if there is no current session andcreateis true, returns a new session.SessiongetSessionInternal()SessiongetSessionInternal(boolean create)InputStreamgetStream()Map<String,String>getTrailerFields()Obtain a Map of the trailer fields that is not backed by the request object.protected B2CConvertergetURIConverter()PrincipalgetUserPrincipal()Returns ajava.security.Principalobject containing the name of the current authenticated user.WrappergetWrapper()booleanisAsync()booleanisAsyncCompleting()booleanisAsyncDispatching()booleanisAsyncStarted()booleanisAsyncSupported()booleanisFinished()booleanisParametersParsed()booleanisRequestedSessionIdFromCookie()Checks whether the requested session ID came in as a cookie.booleanisRequestedSessionIdFromURL()Checks whether the requested session ID came in as part of the request URL.booleanisRequestedSessionIdValid()Checks whether the requested session ID is still valid.booleanisSecure()Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.booleanisTrailerFieldsReady()Are trailer fields ready to be read (there may still be no trailers to read).booleanisUserInRole(String role)Returns a boolean indicating whether the authenticated user is included in the specified logical "role".voidlogin(String username, String password)Authenticate the provided user name and password and then associated the authenticated user with the request.voidlogout()Removes any authenticated user from the request.PushBuildernewPushBuilder()Obtain a builder for generating push requests.PushBuildernewPushBuilder(HttpServletRequest request)protected voidparseCookies()Parse cookies.protected voidparseLocales()Parse request locales.protected voidparseLocalesHeader(String value, TreeMap<Double,ArrayList<Locale>> locales)Parse accept-language header value.protected voidparseParameters()Parse request parameters.protected byte[]readChunkedPostBody()Read chunked post body.protected intreadPostBody(byte[] body, int len)Read post body in an array.voidrecycle()Release all object references, and initialize instance variables, in preparation for reuse of this object.protected voidrecycleCookieInfo(boolean recycleCoyote)protected voidrecycleSessionInfo()voidremoveAttribute(String name)Remove the specified request attribute if it exists.voidremoveNote(String name)Remove any object bound to the specified name in the internal notes for this request.voidsetAsyncSupported(boolean asyncSupported)voidsetAttribute(String name, Object value)Set the specified request attribute to the specified value.voidsetAuthType(String type)Set the authentication type used for this request, if any; otherwise set the type tonull.voidsetCharacterEncoding(String enc)Overrides the name of the character encoding used in the body of this request.voidsetContentType(String contentType)Set the content type for this Request.voidsetCoyoteRequest(Request coyoteRequest)Set the Coyote request.voidsetFilterChain(FilterChain filterChain)Set filter chain associated with the request.voidsetLocalPort(int port)Set the port number of the server to process this request.voidsetNote(String name, Object value)Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.voidsetPathInfo(String path)Set the path information for this Request.voidsetRemoteAddr(String remoteAddr)Set the IP address of the remote client associated with this Request.voidsetRemoteHost(String remoteHost)Set the fully qualified name of the remote client associated with this Request.voidsetRequest(HttpServletRequest applicationRequest)Set a wrapped HttpServletRequest to pass to the application.voidsetRequestedSessionCookie(boolean flag)Set a flag indicating whether or not the requested session ID for this request came in through a cookie.voidsetRequestedSessionId(String id)Set the requested session ID for this request.voidsetRequestedSessionSSL(boolean flag)Set a flag indicating whether or not the requested session ID for this request came in through SSL.voidsetRequestedSessionURL(boolean flag)Set a flag indicating whether or not the requested session ID for this request came in through a URL.voidsetResponse(Response response)Set the Response with which this Request is associated.voidsetSecure(boolean secure)Set the value to be returned byisSecure()for this Request.voidsetServerPort(int port)Set the port number of the server to process this request.protected voidsetURIConverter(B2CConverter URIConverter)Set the URI converter.voidsetUserPrincipal(Principal principal)Set the Principal who has been authenticated for this Request.AsyncContextstartAsync()AsyncContextstartAsync(ServletRequest request, ServletResponse response)protected Stringunescape(String s)<T extends HttpUpgradeHandler>
Tupgrade(Class<T> httpUpgradeHandlerClass)Start the HTTP upgrade process and create and instance of the provided protocol handler class.
-
-
-
Field Detail
-
coyoteRequest
protected Request coyoteRequest
Coyote request.
-
sm
protected static final StringManager sm
The string manager for this package.
-
cookies
protected Cookie[] cookies
The set of cookies associated with this Request.
-
defaultLocale
protected static final Locale defaultLocale
The default Locale if none are specified.
-
sslAttributesParsed
protected boolean sslAttributesParsed
Flag that indicates if SSL attributes have been parsed to improve performance for applications (usually frameworks) that make multiple calls togetAttributeNames().
-
locales
protected final ArrayList<Locale> locales
The preferred Locales associated with this Request.
-
authType
protected String authType
Authentication type.
-
internalDispatcherType
protected DispatcherType internalDispatcherType
The current dispatcher type.
-
inputBuffer
protected final InputBuffer inputBuffer
The associated input buffer.
-
inputStream
protected CoyoteInputStream inputStream
ServletInputStream.
-
reader
protected CoyoteReader reader
Reader.
-
usingInputStream
protected boolean usingInputStream
Using stream flag.
-
usingReader
protected boolean usingReader
Using reader flag.
-
userPrincipal
protected Principal userPrincipal
User principal.
-
parametersParsed
protected boolean parametersParsed
Request parameters parsed flag.
-
cookiesParsed
protected boolean cookiesParsed
Cookie headers parsed flag. Indicates that the cookie headers have been parsed into ServerCookies.
-
cookiesConverted
protected boolean cookiesConverted
Cookie parsed flag. Indicates that the ServerCookies have been converted into user facing Cookie objects.
-
secure
protected boolean secure
Secure flag.
-
subject
protected transient Subject subject
The Subject associated with the current AccessControlContext
-
CACHED_POST_LEN
protected static final int CACHED_POST_LEN
Post data buffer.- See Also:
- Constant Field Values
-
postData
protected byte[] postData
-
parameterMap
protected ParameterMap<String,String[]> parameterMap
Hash map used in the getParametersMap method.
-
parts
protected Collection<Part> parts
The parts, if any, uploaded with this request.
-
partsParseException
protected Exception partsParseException
The exception thrown, if any when parsing the parts.
-
session
protected Session session
The currently active session for this request.
-
requestDispatcherPath
protected Object requestDispatcherPath
The current request dispatcher path.
-
requestedSessionCookie
protected boolean requestedSessionCookie
Was the requested session ID received in a cookie?
-
requestedSessionId
protected String requestedSessionId
The requested session ID (if any) for this request.
-
requestedSessionURL
protected boolean requestedSessionURL
Was the requested session ID received in a URL?
-
requestedSessionSSL
protected boolean requestedSessionSSL
Was the requested session ID obtained from the SSL session?
-
localesParsed
protected boolean localesParsed
Parse locales.
-
localPort
protected int localPort
Local port
-
remoteAddr
protected String remoteAddr
Remote address.
-
peerAddr
protected String peerAddr
Connection peer address.
-
remoteHost
protected String remoteHost
Remote host.
-
remotePort
protected int remotePort
Remote port
-
localAddr
protected String localAddr
Local address
-
localName
protected String localName
Local address
-
asyncSupported
protected Boolean asyncSupported
-
connector
protected final Connector connector
Associated Catalina connector.
-
filterChain
protected FilterChain filterChain
Filter chain associated with the request.
-
mappingData
protected final MappingData mappingData
Mapping data.
-
facade
protected RequestFacade facade
The facade associated with this request.
-
response
protected Response response
The response with which this request is associated.
-
URIConverter
protected B2CConverter URIConverter
URI byte to char converter.
-
-
Constructor Detail
-
Request
public Request(Connector connector)
Create a new Request object associated with the given Connector.- Parameters:
connector- The Connector with which this Request object will always be associated. In normal usage this must be non-null. In some test scenarios, it may be possible to use a null Connector without triggering an NPE.
-
-
Method Detail
-
setCoyoteRequest
public void setCoyoteRequest(Request coyoteRequest)
Set the Coyote request.- Parameters:
coyoteRequest- The Coyote request
-
getCoyoteRequest
public Request getCoyoteRequest()
Get the Coyote request.- Returns:
- the Coyote request object
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported)
-
recycle
public void recycle()
Release all object references, and initialize instance variables, in preparation for reuse of this object.
-
recycleSessionInfo
protected void recycleSessionInfo()
-
recycleCookieInfo
protected void recycleCookieInfo(boolean recycleCoyote)
-
getConnector
public Connector getConnector()
- Returns:
- the Connector through which this Request was received.
-
getContext
public Context getContext()
Return the Context within which this Request is being processed.This is available as soon as the appropriate Context is identified. Note that availability of a Context allows
getContextPath()to return a value, and thus enables parsing of the request URI.- Returns:
- the Context mapped with the request
-
getDiscardFacades
public boolean getDiscardFacades()
Get the recycling strategy of the facade objects.- Returns:
- the value of the flag as set on the connector, or
trueif no connector is associated with this request
-
getFilterChain
public FilterChain getFilterChain()
Get filter chain associated with the request.- Returns:
- the associated filter chain
-
setFilterChain
public void setFilterChain(FilterChain filterChain)
Set filter chain associated with the request.- Parameters:
filterChain- new filter chain
-
getHost
public Host getHost()
- Returns:
- the Host within which this Request is being processed.
-
getMappingData
public MappingData getMappingData()
- Returns:
- mapping data.
-
getRequest
public HttpServletRequest getRequest()
- Returns:
- the
ServletRequestfor which this object is the facade. This method must be implemented by a subclass.
-
setRequest
public void setRequest(HttpServletRequest applicationRequest)
Set a wrapped HttpServletRequest to pass to the application. Components wishing to wrap the request should obtain the request viagetRequest(), wrap it and then call this method with the wrapped request.- Parameters:
applicationRequest- The wrapped request to pass to the application
-
getResponse
public Response getResponse()
- Returns:
- the Response with which this Request is associated.
-
setResponse
public void setResponse(Response response)
Set the Response with which this Request is associated.- Parameters:
response- The new associated response
-
getStream
public InputStream getStream()
- Returns:
- the input stream associated with this Request.
-
getURIConverter
protected B2CConverter getURIConverter()
- Returns:
- the URI converter.
-
setURIConverter
protected void setURIConverter(B2CConverter URIConverter)
Set the URI converter.- Parameters:
URIConverter- the new URI converter
-
getWrapper
public Wrapper getWrapper()
- Returns:
- the Wrapper within which this Request is being processed.
-
createInputStream
public ServletInputStream createInputStream() throws IOException
Create and return a ServletInputStream to read the content associated with this Request.- Returns:
- the created input stream
- Throws:
IOException- if an input/output error occurs
-
finishRequest
public void finishRequest() throws IOExceptionPerform whatever actions are required to flush and close the input stream or reader, in a single operation.- Throws:
IOException- if an input/output error occurs
-
getNote
public Object getNote(String name)
- Parameters:
name- Name of the note to be returned- Returns:
- the object bound with the specified name to the internal notes
for this request, or
nullif no such binding exists.
-
removeNote
public void removeNote(String name)
Remove any object bound to the specified name in the internal notes for this request.- Parameters:
name- Name of the note to be removed
-
setLocalPort
public void setLocalPort(int port)
Set the port number of the server to process this request.- Parameters:
port- The server port
-
setNote
public void setNote(String name, Object value)
Bind an object to a specified name in the internal notes associated with this request, replacing any existing binding for this name.- Parameters:
name- Name to which the object should be boundvalue- Object to be bound to the specified name
-
setRemoteAddr
public void setRemoteAddr(String remoteAddr)
Set the IP address of the remote client associated with this Request.- Parameters:
remoteAddr- The remote IP address
-
setRemoteHost
public void setRemoteHost(String remoteHost)
Set the fully qualified name of the remote client associated with this Request.- Parameters:
remoteHost- The remote host name
-
setSecure
public void setSecure(boolean secure)
Set the value to be returned byisSecure()for this Request.- Parameters:
secure- The new isSecure value
-
setServerPort
public void setServerPort(int port)
Set the port number of the server to process this request.- Parameters:
port- The server port
-
getAttribute
public Object getAttribute(String name)
Description copied from interface:jakarta.servlet.ServletRequestReturns the value of the named attribute as anObject, ornullif no attribute of the given name exists.Attributes can be set two ways. The servlet container may set attributes to make available custom information about a request. For example, for requests made using HTTPS, the attribute
jakarta.servlet.request.X509Certificatecan be used to retrieve information on the certificate of the client. Attributes can also be set programmatically usingServletRequest.setAttribute(java.lang.String, java.lang.Object). This allows information to be embedded into a request before aRequestDispatchercall.Attribute names should follow the same conventions as package names. Names beginning with
java.*andjavax.*are reserved for use by the Servlet specification. Names beginning withsun.*,com.sun.*,oracle.*andcom.oracle.*) are reserved for use by Oracle Corporation.- Specified by:
getAttributein interfaceServletRequest- Parameters:
name- Name of the request attribute to return- Returns:
- the specified request attribute if it exists; otherwise, return
null.
-
getContentLengthLong
public long getContentLengthLong()
Description copied from interface:jakarta.servlet.ServletRequestReturns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.- Specified by:
getContentLengthLongin interfaceServletRequest- Returns:
- a long integer containing the length of the request body or -1 if the length is not known
-
getAttributeNames
public Enumeration<String> getAttributeNames()
Return the names of all request attributes for this Request, or an emptyEnumerationif there are none. Note that the attribute names returned will only be those for the attributes set viasetAttribute(String, Object). Tomcat internal attributes will not be included although they are accessible viagetAttribute(String). The Tomcat internal attributes include:Globals.DISPATCHER_TYPE_ATTRGlobals.DISPATCHER_REQUEST_PATH_ATTRGlobals.ASYNC_SUPPORTED_ATTRGlobals.CERTIFICATES_ATTR(SSL connections only)Globals.CIPHER_SUITE_ATTR(SSL connections only)Globals.KEY_SIZE_ATTR(SSL connections only)Globals.SSL_SESSION_ID_ATTR(SSL connections only)Globals.SSL_SESSION_MGR_ATTR(SSL connections only)Globals.PARAMETER_PARSE_FAILED_ATTR
- Specified by:
getAttributeNamesin interfaceServletRequest- Returns:
- the attribute names enumeration
-
getCharacterEncoding
public String getCharacterEncoding()
Description copied from interface:jakarta.servlet.ServletRequestReturns the name of the character encoding used in the body of this request. This method returnsnullif the no character encoding has been specified. The following priority order is used to determine the specified encoding:- per request
- web application default via the deployment descriptor or
ServletContext.setRequestCharacterEncoding(String) - container default via container specific configuration
- Specified by:
getCharacterEncodingin interfaceServletRequest- Returns:
- the character encoding for this Request.
-
getContentLength
public int getContentLength()
Description copied from interface:jakarta.servlet.ServletRequestReturns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_LENGTH.- Specified by:
getContentLengthin interfaceServletRequest- Returns:
- the content length for this Request.
-
getContentType
public String getContentType()
Description copied from interface:jakarta.servlet.ServletRequestReturns the MIME type of the body of the request, ornullif the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.- Specified by:
getContentTypein interfaceServletRequest- Returns:
- the content type for this Request.
-
setContentType
public void setContentType(String contentType)
Set the content type for this Request.- Parameters:
contentType- The content type
-
getInputStream
public ServletInputStream getInputStream() throws IOException
Description copied from interface:jakarta.servlet.ServletRequestRetrieves the body of the request as binary data using aServletInputStream. Either this method orServletRequest.getReader()may be called to read the body, not both.- Specified by:
getInputStreamin interfaceServletRequest- Returns:
- the servlet input stream for this Request. The default
implementation returns a servlet input stream created by
createInputStream(). - Throws:
IllegalStateException- ifgetReader()has already been called for this requestIOException- if an input/output error occurs
-
getLocale
public Locale getLocale()
Description copied from interface:jakarta.servlet.ServletRequestReturns the preferredLocalethat the client will accept content in, based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.- Specified by:
getLocalein interfaceServletRequest- Returns:
- the preferred Locale that the client will accept content in,
based on the value for the first
Accept-Languageheader that was encountered. If the request did not specify a preferred language, the server's default Locale is returned.
-
getLocales
public Enumeration<Locale> getLocales()
Description copied from interface:jakarta.servlet.ServletRequestReturns anEnumerationofLocaleobjects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header. If the client request doesn't provide an Accept-Language header, this method returns anEnumerationcontaining oneLocale, the default locale for the server.- Specified by:
getLocalesin interfaceServletRequest- Returns:
- the set of preferred Locales that the client will accept
content in, based on the values for any
Accept-Languageheaders that were encountered. If the request did not specify a preferred language, the server's default Locale is returned.
-
getParameter
public String getParameter(String name)
Description copied from interface:jakarta.servlet.ServletRequestReturns the value of a request parameter as aString, ornullif the parameter does not exist. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.You should only use this method when you are sure the parameter has only one value. If the parameter might have more than one value, use
ServletRequest.getParameterValues(java.lang.String).If you use this method with a multivalued parameter, the value returned is equal to the first value in the array returned by
getParameterValues.If the parameter data was sent in the request body, such as occurs with an HTTP POST request, then reading the body directly via
ServletRequest.getInputStream()orServletRequest.getReader()can interfere with the execution of this method.- Specified by:
getParameterin interfaceServletRequest- Parameters:
name- Name of the desired request parameter- Returns:
- the value of the specified request parameter, if any; otherwise,
return
null. If there is more than one value defined, return only the first one. - See Also:
ServletRequest.getParameterValues(java.lang.String)
-
getParameterMap
public Map<String,String[]> getParameterMap()
Returns aMapof the parameters of this request. Request parameters are extra information sent with the request. For HTTP servlets, parameters are contained in the query string or posted form data.- Specified by:
getParameterMapin interfaceServletRequest- Returns:
- A
Mapcontaining parameter names as keys and parameter values as map values.
-
getParameterNames
public Enumeration<String> getParameterNames()
Description copied from interface:jakarta.servlet.ServletRequestReturns anEnumerationofStringobjects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyEnumeration.- Specified by:
getParameterNamesin interfaceServletRequest- Returns:
- the names of all defined request parameters for this request.
-
getParameterValues
public String[] getParameterValues(String name)
Description copied from interface:jakarta.servlet.ServletRequestReturns an array ofStringobjects containing all of the values the given request parameter has, ornullif the parameter does not exist.If the parameter has a single value, the array has a length of 1.
- Specified by:
getParameterValuesin interfaceServletRequest- Parameters:
name- Name of the desired request parameter- Returns:
- the defined values for the specified request parameter, if any;
otherwise, return
null. - See Also:
ServletRequest.getParameter(java.lang.String)
-
getProtocol
public String getProtocol()
Description copied from interface:jakarta.servlet.ServletRequestReturns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1. For HTTP servlets, the value returned is the same as the value of the CGI variableSERVER_PROTOCOL.- Specified by:
getProtocolin interfaceServletRequest- Returns:
- the protocol and version used to make this Request.
-
getReader
public BufferedReader getReader() throws IOException
Read the Reader wrapping the input stream for this Request. The default implementation wraps aBufferedReaderaround the servlet input stream returned bycreateInputStream().- Specified by:
getReaderin interfaceServletRequest- Returns:
- a buffered reader for the request
- Throws:
IllegalStateException- ifgetInputStream()has already been called for this requestIOException- if an input/output error occurs- See Also:
ServletRequest.getInputStream()
-
getRemoteAddr
public String getRemoteAddr()
Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variableREMOTE_ADDR.- Specified by:
getRemoteAddrin interfaceServletRequest- Returns:
- the remote IP address making this Request.
-
getPeerAddr
public String getPeerAddr()
- Returns:
- the connection peer IP address making this Request.
-
getRemoteHost
public String getRemoteHost()
Description copied from interface:jakarta.servlet.ServletRequestReturns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variableREMOTE_HOST.- Specified by:
getRemoteHostin interfaceServletRequest- Returns:
- the remote host name making this Request.
-
getRemotePort
public int getRemotePort()
Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- Specified by:
getRemotePortin interfaceServletRequest- Returns:
- the Internet Protocol (IP) source port of the client or last proxy that sent the request.
-
getLocalName
public String getLocalName()
Description copied from interface:jakarta.servlet.ServletRequestReturns the host name of the Internet Protocol (IP) interface on which the request was received.- Specified by:
getLocalNamein interfaceServletRequest- Returns:
- the host name of the Internet Protocol (IP) interface on which the request was received.
-
getLocalAddr
public String getLocalAddr()
Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) address of the interface on which the request was received.- Specified by:
getLocalAddrin interfaceServletRequest- Returns:
- the Internet Protocol (IP) address of the interface on which the request was received.
-
getLocalPort
public int getLocalPort()
Description copied from interface:jakarta.servlet.ServletRequestReturns the Internet Protocol (IP) port number of the interface on which the request was received.- Specified by:
getLocalPortin interfaceServletRequest- Returns:
- the Internet Protocol (IP) port number of the interface on which the request was received.
-
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String path)
Description copied from interface:jakarta.servlet.ServletRequestReturns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path. ARequestDispatcherobject can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.The pathname specified may be relative, although it cannot extend outside the current servlet context. If the path begins with a "/" it is interpreted as relative to the current context root. This method returns
nullif the servlet container cannot return aRequestDispatcher.The difference between this method and
ServletContext.getRequestDispatcher(java.lang.String)is that this method can take a relative path.- Specified by:
getRequestDispatcherin interfaceServletRequest- Parameters:
path- Path of the resource to be wrapped- Returns:
- a RequestDispatcher that wraps the resource at the specified path, which may be interpreted as relative to the current request path.
- See Also:
RequestDispatcher,ServletContext.getRequestDispatcher(java.lang.String)
-
getScheme
public String getScheme()
Description copied from interface:jakarta.servlet.ServletRequestReturns the name of the scheme used to make this request, for example,http,https, orftp. Different schemes have different rules for constructing URLs, as noted in RFC 1738.- Specified by:
getSchemein interfaceServletRequest- Returns:
- the scheme used to make this Request.
-
getServerName
public String getServerName()
Description copied from interface:jakarta.servlet.ServletRequestReturns the host name of the server to which the request was sent. It is the value of the part before ":" in theHostheader value, if any, or the resolved server name, or the server IP address.- Specified by:
getServerNamein interfaceServletRequest- Returns:
- the server name responding to this Request.
-
getServerPort
public int getServerPort()
Description copied from interface:jakarta.servlet.ServletRequestReturns the port number to which the request was sent. It is the value of the part after ":" in theHostheader value, if any, or the server port where the client connection was accepted on.- Specified by:
getServerPortin interfaceServletRequest- Returns:
- the server port responding to this Request.
-
isSecure
public boolean isSecure()
Description copied from interface:jakarta.servlet.ServletRequestReturns a boolean indicating whether this request was made using a secure channel, such as HTTPS.- Specified by:
isSecurein interfaceServletRequest- Returns:
trueif this request was received on a secure connection.
-
removeAttribute
public void removeAttribute(String name)
Remove the specified request attribute if it exists.- Specified by:
removeAttributein interfaceServletRequest- Parameters:
name- Name of the request attribute to remove
-
setAttribute
public void setAttribute(String name, Object value)
Set the specified request attribute to the specified value.- Specified by:
setAttributein interfaceServletRequest- Parameters:
name- Name of the request attribute to setvalue- The associated value
-
setCharacterEncoding
public void setCharacterEncoding(String enc) throws UnsupportedEncodingException
Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input usinggetReader().- Specified by:
setCharacterEncodingin interfaceServletRequest- Parameters:
enc- The character encoding to be used- Throws:
UnsupportedEncodingException- if the specified encoding is not supported- Since:
- Servlet 2.3
-
getServletContext
public ServletContext getServletContext()
- Specified by:
getServletContextin interfaceServletRequest- Returns:
- TODO
-
startAsync
public AsyncContext startAsync()
- Specified by:
startAsyncin interfaceServletRequest- Returns:
- TODO
-
startAsync
public AsyncContext startAsync(ServletRequest request, ServletResponse response)
- Specified by:
startAsyncin interfaceServletRequest- Parameters:
request- The ServletRequest with which to initialise the asynchronous contextresponse- The ServletResponse with which to initialise the asynchronous context- Returns:
- TODO
-
isAsyncStarted
public boolean isAsyncStarted()
- Specified by:
isAsyncStartedin interfaceServletRequest- Returns:
- TODO
-
isAsyncDispatching
public boolean isAsyncDispatching()
-
isAsyncCompleting
public boolean isAsyncCompleting()
-
isAsync
public boolean isAsync()
-
isAsyncSupported
public boolean isAsyncSupported()
- Specified by:
isAsyncSupportedin interfaceServletRequest- Returns:
- TODO
-
getAsyncContext
public AsyncContext getAsyncContext()
Description copied from interface:jakarta.servlet.ServletRequestGet the current AsyncContext.- Specified by:
getAsyncContextin interfaceServletRequest- Returns:
- The current AsyncContext
-
getAsyncContextInternal
public AsyncContextImpl getAsyncContextInternal()
-
getDispatcherType
public DispatcherType getDispatcherType()
- Specified by:
getDispatcherTypein interfaceServletRequest- Returns:
- TODO
-
getRequestId
public String getRequestId()
Description copied from interface:jakarta.servlet.ServletRequestObtain a unique (within the lifetime of the Servlet container) identifier string for this request.There is no defined format for this string. The format is implementation dependent.
- Specified by:
getRequestIdin interfaceServletRequest- Returns:
- A unique identifier for the request
-
getProtocolRequestId
public String getProtocolRequestId()
Description copied from interface:jakarta.servlet.ServletRequestObtain the request identifier for this request as defined by the protocol in use. Note that some protocols do not define such an identifier.Examples of protocol provided request identifiers include:
- HTTP 1.x
- None, so the empty string should be returned
- HTTP 2
- The stream identifier
- HTTP 3
- The stream identifier
- AJP
- None, so the empty string should be returned
- Specified by:
getProtocolRequestIdin interfaceServletRequest- Returns:
- The request identifier if one is defined, otherwise an empty string
-
getServletConnection
public ServletConnection getServletConnection()
Description copied from interface:jakarta.servlet.ServletRequestObtain details of the network connection to the Servlet container that is being used by this request. The information presented may differ from information presented elsewhere in the Servlet API as raw information is presented without adjustments for, example, use of reverse proxies that may be applied elsewhere in the Servlet API.- Specified by:
getServletConnectionin interfaceServletRequest- Returns:
- The network connection details.
-
addCookie
public void addCookie(Cookie cookie)
Add a Cookie to the set of Cookies associated with this Request.- Parameters:
cookie- The new cookie
-
addLocale
public void addLocale(Locale locale)
Add a Locale to the set of preferred Locales for this Request. The first added Locale will be the first one returned by getLocales().- Parameters:
locale- The new preferred Locale
-
clearCookies
public void clearCookies()
Clear the collection of Cookies associated with this Request.
-
clearLocales
public void clearLocales()
Clear the collection of Locales associated with this Request.
-
setAuthType
public void setAuthType(String type)
Set the authentication type used for this request, if any; otherwise set the type tonull. Typical values are "BASIC", "DIGEST", or "SSL".- Parameters:
type- The authentication type used
-
setPathInfo
public void setPathInfo(String path)
Set the path information for this Request. This will normally be called when the associated Context is mapping the Request to a particular Wrapper.- Parameters:
path- The path information
-
setRequestedSessionCookie
public void setRequestedSessionCookie(boolean flag)
Set a flag indicating whether or not the requested session ID for this request came in through a cookie. This is normally called by the HTTP Connector, when it parses the request headers.- Parameters:
flag- The new flag
-
setRequestedSessionId
public void setRequestedSessionId(String id)
Set the requested session ID for this request. This is normally called by the HTTP Connector, when it parses the request headers.- Parameters:
id- The new session id
-
setRequestedSessionURL
public void setRequestedSessionURL(boolean flag)
Set a flag indicating whether or not the requested session ID for this request came in through a URL. This is normally called by the HTTP Connector, when it parses the request headers.- Parameters:
flag- The new flag
-
setRequestedSessionSSL
public void setRequestedSessionSSL(boolean flag)
Set a flag indicating whether or not the requested session ID for this request came in through SSL. This is normally called by the HTTP Connector, when it parses the request headers.- Parameters:
flag- The new flag
-
getDecodedRequestURI
public String getDecodedRequestURI()
Get the decoded request URI.- Returns:
- the URL decoded request URI
-
getDecodedRequestURIMB
public MessageBytes getDecodedRequestURIMB()
Get the decoded request URI.- Returns:
- the URL decoded request URI
-
setUserPrincipal
public void setUserPrincipal(Principal principal)
Set the Principal who has been authenticated for this Request. This value is also used to calculate the value to be returned by thegetRemoteUser()method.- Parameters:
principal- The user Principal
-
isTrailerFieldsReady
public boolean isTrailerFieldsReady()
Description copied from interface:jakarta.servlet.http.HttpServletRequestAre trailer fields ready to be read (there may still be no trailers to read). This method always returnstrueif the underlying protocol does not support trailer fields. Otherwise,trueis returned once all of the following are true:- The application has ready all the request data and an EOF has been received or the content-length is zero
- All trailer fields, if any, have been received
- Specified by:
isTrailerFieldsReadyin interfaceHttpServletRequest- Returns:
trueif trailers are ready to be read
-
getTrailerFields
public Map<String,String> getTrailerFields()
Description copied from interface:jakarta.servlet.http.HttpServletRequestObtain a Map of the trailer fields that is not backed by the request object.- Specified by:
getTrailerFieldsin interfaceHttpServletRequest- Returns:
- A Map of the received trailer fields with all keys lower case or an empty Map if no trailers are present
-
newPushBuilder
public PushBuilder newPushBuilder()
Description copied from interface:jakarta.servlet.http.HttpServletRequestObtain a builder for generating push requests.PushBuilderdocuments how this request will be used as the basis for a push request. Each call to this method will return a new instance, independent of any previous instance obtained.- Specified by:
newPushBuilderin interfaceHttpServletRequest- Returns:
- A builder that can be used to generate push requests based on
this request or
nullif push is not supported. Note that even if a PushBuilder instance is returned, by the time thatPushBuilder.push()is called, it may no longer be valid to push a request and the push request will be ignored.
-
newPushBuilder
public PushBuilder newPushBuilder(HttpServletRequest request)
-
upgrade
public <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass) throws IOException, ServletException
Description copied from interface:jakarta.servlet.http.HttpServletRequestStart the HTTP upgrade process and create and instance of the provided protocol handler class. The connection will be passed this instance once the current request/response pair has completed processing. Calling this method sets the response status toHttpServletResponse.SC_SWITCHING_PROTOCOLS.- Specified by:
upgradein interfaceHttpServletRequest- Type Parameters:
T- The type of the upgrade handler- Parameters:
httpUpgradeHandlerClass- The class that implements the upgrade handler- Returns:
- A newly created instance of the specified upgrade handler type
- Throws:
IOException- if an I/O error occurred during the upgradeServletException- if the given httpUpgradeHandlerClass fails to be instantiated
-
getAuthType
public String getAuthType()
Return the authentication type used for this Request.- Specified by:
getAuthTypein interfaceHttpServletRequest- Returns:
- one of the static members BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH,
DIGEST_AUTH (suitable for == comparison) or the
container-specific string indicating the authentication scheme,
or
nullif the request was not authenticated.
-
getContextPath
public String getContextPath()
Return the portion of the request URI used to select the Context of the Request. The value returned is not decoded which also implies it is not normalised.- Specified by:
getContextPathin interfaceHttpServletRequest- Returns:
- a
Stringspecifying the portion of the request URI that indicates the context of the request
-
getCookies
public Cookie[] getCookies()
Return the set of Cookies received with this Request. Triggers parsing of the Cookie HTTP headers followed by conversion to Cookie objects if this has not already been performed.- Specified by:
getCookiesin interfaceHttpServletRequest- Returns:
- the array of cookies
-
getServerCookies
public ServerCookies getServerCookies()
Return the server representation of the cookies associated with this request. Triggers parsing of the Cookie HTTP headers (but not conversion to Cookie objects) if the headers have not yet been parsed.- Returns:
- the server cookies
-
getDateHeader
public long getDateHeader(String name)
Return the value of the specified date header, if any; otherwise return -1.- Specified by:
getDateHeaderin interfaceHttpServletRequest- Parameters:
name- Name of the requested date header- Returns:
- the date as a long
- Throws:
IllegalArgumentException- if the specified header value cannot be converted to a date
-
getHeader
public String getHeader(String name)
Return the first value of the specified header, if any; otherwise, returnnull- Specified by:
getHeaderin interfaceHttpServletRequest- Parameters:
name- Name of the requested header- Returns:
- the header value
-
getHeaders
public Enumeration<String> getHeaders(String name)
Return all of the values of the specified header, if any; otherwise, return an empty enumeration.- Specified by:
getHeadersin interfaceHttpServletRequest- Parameters:
name- Name of the requested header- Returns:
- the enumeration with the header values
-
getHeaderNames
public Enumeration<String> getHeaderNames()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns an enumeration of all the header names this request contains. If the request has no headers, this method returns an empty enumeration.Some servlet containers do not allow servlets to access headers using this method, in which case this method returns
null- Specified by:
getHeaderNamesin interfaceHttpServletRequest- Returns:
- the names of all headers received with this request.
-
getIntHeader
public int getIntHeader(String name)
Return the value of the specified header as an integer, or -1 if there is no such header for this request.- Specified by:
getIntHeaderin interfaceHttpServletRequest- Parameters:
name- Name of the requested header- Returns:
- the header value as an int
- Throws:
IllegalArgumentException- if the specified header value cannot be converted to an integer
-
getHttpServletMapping
public HttpServletMapping getHttpServletMapping()
Description copied from interface:jakarta.servlet.http.HttpServletRequestObtain the mapping information for this request.- Specified by:
getHttpServletMappingin interfaceHttpServletRequest- Returns:
- the mapping information for this request
-
getMethod
public String getMethod()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD.- Specified by:
getMethodin interfaceHttpServletRequest- Returns:
- the HTTP request method used in this Request.
-
getPathInfo
public String getPathInfo()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns any extra path information associated with the URL the client sent when it made this request. The extra path information follows the servlet path but precedes the query string and will start with a "/" character.This method returns
nullif there was no extra path information.The URL will be canonicalized as per section 3.5 of the specification before the path information, if any, is extracted.
- Specified by:
getPathInfoin interfaceHttpServletRequest- Returns:
- the path information associated with this Request.
-
getPathTranslated
public String getPathTranslated()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns any extra path information after the servlet name but before the query string, and translates it to a real path. Same as the value of the CGI variable PATH_TRANSLATED.If the URL does not have any extra path information, this method returns
nullor the servlet container cannot translate the virtual path to a real path for any reason (such as when the web application is executed from an archive). The web container does not decode this string.- Specified by:
getPathTranslatedin interfaceHttpServletRequest- Returns:
- the extra path information for this request, translated to a real path.
-
getQueryString
public String getQueryString()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the query string that is contained in the request URL after the path. This method returnsnullif the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.- Specified by:
getQueryStringin interfaceHttpServletRequest- Returns:
- the query string associated with this request.
-
getRemoteUser
public String getRemoteUser()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the login of the user making this request, if the user has been authenticated, ornullif the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.- Specified by:
getRemoteUserin interfaceHttpServletRequest- Returns:
- the name of the remote user that has been authenticated for this Request.
-
getRequestPathMB
public MessageBytes getRequestPathMB()
Get the request path.- Returns:
- the request path
-
getRequestedSessionId
public String getRequestedSessionId()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the session ID specified by the client. This may not be the same as the ID of the current valid session for this request. If the client did not specify a session ID, this method returnsnull.- Specified by:
getRequestedSessionIdin interfaceHttpServletRequest- Returns:
- the session identifier included in this request, if any.
- See Also:
HttpServletRequest.isRequestedSessionIdValid()
-
getRequestURI
public String getRequestURI()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String. For example:Examples of Returned Values First line of HTTP request Returned Value POST /some/path.html HTTP/1.1 /some/path.html GET http://foo.bar/a.html HTTP/1.0 /a.html HEAD /xyz?a=b HTTP/1.1 /xyz To reconstruct a URL with a scheme and host, use
HttpServletRequest.getRequestURL().- Specified by:
getRequestURIin interfaceHttpServletRequest- Returns:
- the request URI for this request.
- See Also:
HttpServletRequest.getRequestURL()
-
getRequestURL
public StringBuffer getRequestURL()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and server path, but it does not include query string parameters.Because this method returns a
StringBuffer, not a string, you can modify the URL easily, for example, to append query parameters.This method is useful for creating redirect messages and for reporting errors.
- Specified by:
getRequestURLin interfaceHttpServletRequest- Returns:
- a
StringBufferobject containing the reconstructed URL
-
getServletPath
public String getServletPath()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the part of this request's URL that calls the servlet. This path starts with a "/" character and includes either the servlet name or a path to the servlet, but does not include any extra path information or a query string. Same as the value of the CGI variable SCRIPT_NAME.The URL will be canonicalized as per section 3.5 of the specification before the path information, if any, is extracted.
This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
- Specified by:
getServletPathin interfaceHttpServletRequest- Returns:
- the portion of the request URI used to select the servlet that will process this request.
-
getSession
public HttpSession getSession()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the current session associated with this request, or if the request does not have a session, creates one.- Specified by:
getSessionin interfaceHttpServletRequest- Returns:
- the session associated with this Request, creating one if necessary.
- See Also:
HttpServletRequest.getSession(boolean)
-
getSession
public HttpSession getSession(boolean create)
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns the currentHttpSessionassociated with this request or, if there is no current session andcreateis true, returns a new session.If
createisfalseand the request has no validHttpSession, this method returnsnull.To make sure the session is properly maintained, you must call this method before the response is committed. If the container is using cookies to maintain session integrity and is asked to create a new session when the response is committed, an IllegalStateException is thrown.
- Specified by:
getSessionin interfaceHttpServletRequest- Parameters:
create- Create a new session if one does not exist- Returns:
- the session associated with this Request, creating one if necessary and requested.
- See Also:
HttpServletRequest.getSession()
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID came in as a cookie.- Specified by:
isRequestedSessionIdFromCookiein interfaceHttpServletRequest- Returns:
trueif the session identifier included in this request came from a cookie.- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID came in as part of the request URL.- Specified by:
isRequestedSessionIdFromURLin interfaceHttpServletRequest- Returns:
trueif the session identifier included in this request came from the request URI.- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
Description copied from interface:jakarta.servlet.http.HttpServletRequestChecks whether the requested session ID is still valid.- Specified by:
isRequestedSessionIdValidin interfaceHttpServletRequest- Returns:
trueif the session identifier included in this request identifies a valid session.- See Also:
HttpServletRequest.getRequestedSessionId(),HttpServletRequest.getSession(boolean)
-
isUserInRole
public boolean isUserInRole(String role)
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returnsfalse.- Specified by:
isUserInRolein interfaceHttpServletRequest- Parameters:
role- Role name to be validated- Returns:
trueif the authenticated user principal possesses the specified role name.
-
getPrincipal
public Principal getPrincipal()
- Returns:
- the principal that has been authenticated for this Request.
-
getUserPrincipal
public Principal getUserPrincipal()
Description copied from interface:jakarta.servlet.http.HttpServletRequestReturns ajava.security.Principalobject containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull.- Specified by:
getUserPrincipalin interfaceHttpServletRequest- Returns:
- the principal that has been authenticated for this Request.
-
getSessionInternal
public Session getSessionInternal()
- Returns:
- the session associated with this Request, creating one if necessary.
-
changeSessionId
public void changeSessionId(String newSessionId)
Change the ID of the session that this request is associated with. There are several things that may trigger an ID change. These include moving between nodes in a cluster and session fixation prevention during the authentication process.- Parameters:
newSessionId- The session to change the session ID for
-
changeSessionId
public String changeSessionId()
Description copied from interface:jakarta.servlet.http.HttpServletRequestChanges the session ID of the session associated with this request. This method does not create a new session object it only changes the ID of the current session.- Specified by:
changeSessionIdin interfaceHttpServletRequest- Returns:
- the new session ID allocated to the session
- See Also:
HttpSessionIdListener
-
getSessionInternal
public Session getSessionInternal(boolean create)
- Parameters:
create- Create a new session if one does not exist- Returns:
- the session associated with this Request, creating one if necessary and requested.
-
isParametersParsed
public boolean isParametersParsed()
- Returns:
trueif we have parsed parameters
-
isFinished
public boolean isFinished()
- Returns:
trueif an attempt has been made to read the request body and all of the request body has been read.
-
checkSwallowInput
protected void checkSwallowInput()
Check the configuration for aborted uploads and if configured to do so, disable the swallowing of any remaining input and close the connection once the response has been written.
-
authenticate
public boolean authenticate(HttpServletResponse response) throws IOException, ServletException
Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.- Specified by:
authenticatein interfaceHttpServletRequest- Parameters:
response- The response to use to return any authentication challenge- Returns:
trueif the user is successfully authenticated andfalseif not- Throws:
IOException- if the authentication process attempted to read from the request or write to the response and an I/O error occurredServletException- if the authentication failed and the caller is expected to handle the failure
-
login
public void login(String username, String password) throws ServletException
Authenticate the provided user name and password and then associated the authenticated user with the request.- Specified by:
loginin interfaceHttpServletRequest- Parameters:
username- The user name to authenticatepassword- The password to use to authenticate the user- Throws:
ServletException- If any ofHttpServletRequest.getRemoteUser(),HttpServletRequest.getUserPrincipal()orHttpServletRequest.getAuthType()are non-null, if the configured authenticator does not support user name and password authentication or if the authentication fails
-
logout
public void logout() throws ServletExceptionRemoves any authenticated user from the request.- Specified by:
logoutin interfaceHttpServletRequest- Throws:
ServletException- If the logout fails
-
getParts
public Collection<Part> getParts() throws IOException, IllegalStateException, ServletException
Return a collection of all uploaded Parts.- Specified by:
getPartsin interfaceHttpServletRequest- Returns:
- A collection of all uploaded Parts.
- Throws:
IOException- if an I/O error occursIllegalStateException- if size limits are exceeded or no multipart configuration is providedServletException- if the request is not multipart/form-data
-
getPart
public Part getPart(String name) throws IOException, IllegalStateException, ServletException
Gets the named Part or null if the Part does not exist. Triggers upload of all Parts.- Specified by:
getPartin interfaceHttpServletRequest- Parameters:
name- The name of the Part to obtain- Returns:
- The named Part or null if the Part does not exist
- Throws:
IOException- if an I/O error occursIllegalStateException- if size limits are exceededServletException- if the request is not multipart/form-data
-
doGetSession
protected Session doGetSession(boolean create)
-
parseCookies
protected void parseCookies()
Parse cookies. This only parses the cookies into the memory efficient ServerCookies structure. It does not populate the Cookie objects.
-
convertCookies
protected void convertCookies()
Converts the parsed cookies (parsing the Cookie headers first if they have not been parsed) into Cookie objects.
-
parseParameters
protected void parseParameters()
Parse request parameters.
-
readPostBody
protected int readPostBody(byte[] body, int len) throws IOExceptionRead post body in an array.- Parameters:
body- The bytes array in which the body will be readlen- The body length- Returns:
- the bytes count that has been read
- Throws:
IOException- if an IO exception occurred
-
readChunkedPostBody
protected byte[] readChunkedPostBody() throws IOExceptionRead chunked post body.- Returns:
- the post body as a bytes array
- Throws:
IOException- if an IO exception occurred
-
parseLocales
protected void parseLocales()
Parse request locales.
-
-