Class Request
- java.lang.Object
-
- org.eclipse.jetty.server.Request
-
- All Implemented Interfaces:
HttpServletRequest
,ServletRequest
@Deprecated(since="2021-05-27") public class Request extends java.lang.Object implements HttpServletRequest
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.Jetty Request.Implements
HttpServletRequest
from thejavax.servlet.http
package.The standard interface of mostly getters, is extended with setters so that the request is mutable by the handlers that it is passed to. This allows the request object to be as lightweight as possible and not actually implement any significant behavior. For example
- The
getContextPath()
method will return null, until the request has been passed to aContextHandler
which matches thegetPathInfo()
with a context path and callssetContextPath(String)
as a result. - the HTTP session methods will all return null sessions until such time as a request has been passed to a
SessionHandler
which checks for session cookies and enables the ability to create new sessions. - The
getServletPath()
method will return null until the request has been passed to aorg.eclipse.jetty.servlet.ServletHandler
and the pathInfo matched against the servlet URL patterns andsetServletPath(String)
called as a result.
A request instance is created for each connection accepted by the server and recycled for each HTTP request received via that connection. An effort is made to avoid reparsing headers and cookies that are likely to be the same for requests from the same connection.
Request instances are recycled, which combined with badly written asynchronous applications can result in calls on requests that have been reset. The code is written in a style to avoid NPE and ISE when such calls are made, as this has often proved generate exceptions that distraction from debugging such bad asynchronous applications. Instead, request methods attempt to not fail when called in an illegal state, so that hopefully the bad application will proceed to a major state event (eg calling AsyncContext.onComplete) which has better asynchronous guards, true atomic state and better failure behaviour that will assist in debugging.
The form content that a request can process is limited to protect from Denial of Service attacks. The size in bytes is limited by
ContextHandler.getMaxFormContentSize()
or if there is no context then the "org.eclipse.jetty.server.Request.maxFormContentSize"Server
attribute. The number of parameters keys is limited byContextHandler.getMaxFormKeys()
or if there is no context then the "org.eclipse.jetty.server.Request.maxFormKeys"Server
attribute.If IOExceptions or timeouts occur while reading form parameters, these are thrown as unchecked Exceptions: ether
RuntimeIOException
,BadMessageException
orRuntimeException
as appropriate.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
MULTIPART_CONFIG_ELEMENT
Deprecated.static java.lang.String
MULTIPARTS
Deprecated.-
Fields inherited from interface javax.servlet.http.HttpServletRequest
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH
-
-
Constructor Summary
Constructors Constructor Description Request(HttpChannel channel, HttpInput input)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addEventListener(java.util.EventListener listener)
Deprecated.boolean
authenticate(HttpServletResponse response)
Deprecated.Triggers the same authentication process as would be triggered if the request is for a resource that is protected by a security constraint.java.lang.String
changeSessionId()
Deprecated.Changes the session ID of the session associated with this request.void
enterSession(HttpSession s)
Deprecated.Remember a session that this request has just entered.void
extractFormParameters(MultiMap<java.lang.String> params)
Deprecated.AsyncContext
getAsyncContext()
Deprecated.Get the current AsyncContext.java.lang.Object
getAttribute(java.lang.String name)
Deprecated.Get Request Attribute.java.util.Enumeration<java.lang.String>
getAttributeNames()
Deprecated.Returns anEnumeration
containing the names of the attributes available to this request.Attributes
getAttributes()
Deprecated.Authentication
getAuthentication()
Deprecated.Get the authentication.java.lang.String
getAuthType()
Deprecated.Returns the name of the authentication scheme used to protect the servlet.static Request
getBaseRequest(ServletRequest request)
Deprecated.Obtain the baseRequest
instance of aServletRequest
, by coercion, unwrapping or special attribute.java.lang.String
getCharacterEncoding()
Deprecated.Returns the name of the character encoding used in the body of this request.int
getContentLength()
Deprecated.Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.long
getContentLengthLong()
Deprecated.Returns the length, in bytes, of the request body and made available by the input stream, or -1 if the length is not known.long
getContentRead()
Deprecated.java.lang.String
getContentType()
Deprecated.Returns the MIME type of the body of the request, ornull
if the type is not known.ContextHandler.Context
getContext()
Deprecated.java.lang.String
getContextPath()
Deprecated.Returns the portion of the request URI that indicates the context of the request.Cookie[]
getCookies()
Deprecated.Returns an array containing all of theCookie
objects the client sent with this request.long
getDateHeader(java.lang.String name)
Deprecated.Returns the value of the specified request header as along
value that represents aDate
object.DispatcherType
getDispatcherType()
Deprecated.ContextHandler.Context
getErrorContext()
Deprecated.java.lang.String
getHeader(java.lang.String name)
Deprecated.Returns the value of the specified request header as aString
.java.util.Enumeration<java.lang.String>
getHeaderNames()
Deprecated.Returns an enumeration of all the header names this request contains.java.util.Enumeration<java.lang.String>
getHeaders(java.lang.String name)
Deprecated.Returns all the values of the specified request header as anEnumeration
ofString
objects.HttpChannel
getHttpChannel()
Deprecated.HttpChannelState
getHttpChannelState()
Deprecated.HttpFields
getHttpFields()
Deprecated.HttpInput
getHttpInput()
Deprecated.HttpURI
getHttpURI()
Deprecated.HttpVersion
getHttpVersion()
Deprecated.int
getInputState()
Deprecated.ServletInputStream
getInputStream()
Deprecated.Retrieves the body of the request as binary data using aServletInputStream
.int
getIntHeader(java.lang.String name)
Deprecated.Returns the value of the specified request header as anint
.java.lang.String
getLocalAddr()
Deprecated.Returns the Internet Protocol (IP) address of the interface on which the request was received.java.util.Locale
getLocale()
Deprecated.Returns the preferredLocale
that the client will accept content in, based on the Accept-Language header.java.util.Enumeration<java.util.Locale>
getLocales()
Deprecated.Returns anEnumeration
ofLocale
objects indicating, in decreasing order starting with the preferred locale, the locales that are acceptable to the client based on the Accept-Language header.java.lang.String
getLocalName()
Deprecated.Returns the host name of the Internet Protocol (IP) interface on which the request was received.int
getLocalPort()
Deprecated.Returns the Internet Protocol (IP) port number of the interface on which the request was received.MetaData.Request
getMetaData()
Deprecated.java.lang.String
getMethod()
Deprecated.Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT.java.lang.String
getOriginalURI()
Deprecated.java.lang.String
getParameter(java.lang.String name)
Deprecated.Returns the value of a request parameter as aString
, ornull
if the parameter does not exist.java.util.Map<java.lang.String,java.lang.String[]>
getParameterMap()
Deprecated.Returns a java.util.Map of the parameters of this request.java.util.Enumeration<java.lang.String>
getParameterNames()
Deprecated.Returns anEnumeration
ofString
objects containing the names of the parameters contained in this request.java.lang.String[]
getParameterValues(java.lang.String name)
Deprecated.Returns an array ofString
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist.Part
getPart(java.lang.String name)
Deprecated.Gets the named Part or null if the Part does not exist.java.util.Collection<Part>
getParts()
Deprecated.Return a collection of all uploaded Parts.java.lang.String
getPathInfo()
Deprecated.Returns any extra path information associated with the URL the client sent when it made this request.java.lang.String
getPathTranslated()
Deprecated.Returns any extra path information after the servlet name but before the query string, and translates it to a real path.java.lang.String
getProtocol()
Deprecated.Returns the name and version of the protocol the request uses in the form protocol/majorVersion.minorVersion, for example, HTTP/1.1.PushBuilder
getPushBuilder()
Deprecated.Get a PushBuilder associated with this request initialized as follows: The method is initialized to "GET" The headers from this request are copied to the Builder, except for: Conditional headers (eg.java.lang.String
getQueryEncoding()
Deprecated.MultiMap<java.lang.String>
getQueryParameters()
Deprecated.java.lang.String
getQueryString()
Deprecated.Returns the query string that is contained in the request URL after the path.java.io.BufferedReader
getReader()
Deprecated.Retrieves the body of the request as character data using aBufferedReader
.java.lang.String
getRealPath(java.lang.String path)
Deprecated.java.lang.String
getRemoteAddr()
Deprecated.Returns the Internet Protocol (IP) address of the client or last proxy that sent the request.java.lang.String
getRemoteHost()
Deprecated.Returns the fully qualified name of the client or the last proxy that sent the request.java.net.InetSocketAddress
getRemoteInetSocketAddress()
Deprecated.Access the underlying RemoteInetSocketAddress
for this request.int
getRemotePort()
Deprecated.Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.java.lang.String
getRemoteUser()
Deprecated.Returns the login of the user making this request, if the user has been authenticated, ornull
if the user has not been authenticated.RequestDispatcher
getRequestDispatcher(java.lang.String path)
Deprecated.Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path.java.lang.String
getRequestedSessionId()
Deprecated.Returns the session ID specified by the client.java.lang.String
getRequestURI()
Deprecated.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.java.lang.StringBuffer
getRequestURL()
Deprecated.Reconstructs the URL the client used to make the request.UserIdentity
getResolvedUserIdentity()
Deprecated.Response
getResponse()
Deprecated.java.lang.StringBuilder
getRootURL()
Deprecated.Reconstructs the URL the client used to make the request.java.lang.String
getScheme()
Deprecated.Returns the name of the scheme used to make this request, for example,http
,https
, orftp
.java.lang.String
getServerName()
Deprecated.Returns the host name of the server to which the request was sent.int
getServerPort()
Deprecated.Returns the port number to which the request was sent.ServletContext
getServletContext()
Deprecated.java.lang.String
getServletName()
Deprecated.java.lang.String
getServletPath()
Deprecated.Returns the part of this request's URL that calls the servlet.ServletResponse
getServletResponse()
Deprecated.HttpSession
getSession()
Deprecated.Returns the current session associated with this request, or if the request does not have a session, creates one.HttpSession
getSession(boolean create)
Deprecated.Returns the currentHttpSession
associated with this request or, if there is no current session andcreate
is true, returns a new session.HttpSession
getSession(SessionHandler sessionHandler)
Deprecated.Find a session that this request has already entered for the given SessionHandlerSessionHandler
getSessionHandler()
Deprecated.long
getTimeStamp()
Deprecated.Get Request TimeStampHttpFields
getTrailers()
Deprecated.UserIdentity
getUserIdentity()
Deprecated.UserIdentity.Scope
getUserIdentityScope()
Deprecated.java.security.Principal
getUserPrincipal()
Deprecated.Returns ajava.security.Principal
object containing the name of the current authenticated user.boolean
hasMetaData()
Deprecated.boolean
isAsyncStarted()
Deprecated.boolean
isAsyncSupported()
Deprecated.boolean
isHandled()
Deprecated.boolean
isHead()
Deprecated.boolean
isPush()
Deprecated.boolean
isPushSupported()
Deprecated.boolean
isRequestedSessionIdFromCookie()
Deprecated.Checks whether the requested session ID came in as a cookie.boolean
isRequestedSessionIdFromUrl()
Deprecated.boolean
isRequestedSessionIdFromURL()
Deprecated.Checks whether the requested session ID came in as part of the request URL.boolean
isRequestedSessionIdValid()
Deprecated.Checks whether the requested session ID is still valid.boolean
isSecure()
Deprecated.Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.boolean
isUserInRole(java.lang.String role)
Deprecated.Returns a boolean indicating whether the authenticated user is included in the specified logical "role".void
login(java.lang.String username, java.lang.String password)
Deprecated.Authenticate the provided user name and password and then associated the authenticated user with the request.void
logout()
Deprecated.Removes any authenticated user from the request.void
mergeQueryParameters(java.lang.String oldQuery, java.lang.String newQuery, boolean updateQueryString)
Deprecated.void
onCompleted()
Deprecated.Called when the request is fully finished being handled.void
onResponseCommit()
Deprecated.Called when a response is about to be committed, ie sent back to the clientvoid
removeAttribute(java.lang.String name)
Deprecated.Removes an attribute from this request.void
removeEventListener(java.util.EventListener listener)
Deprecated.void
resetParameters()
Deprecated.void
setAsyncAttributes()
Deprecated.void
setAsyncSupported(boolean supported, java.lang.Object source)
Deprecated.void
setAttribute(java.lang.String name, java.lang.Object value)
Deprecated.Stores an attribute in this request.void
setAttributes(Attributes attributes)
Deprecated.void
setAuthentication(Authentication authentication)
Deprecated.Set the authentication.void
setAuthority(java.lang.String host, int port)
Deprecated.void
setCharacterEncoding(java.lang.String encoding)
Deprecated.Overrides the name of the character encoding used in the body of this request.void
setCharacterEncodingUnchecked(java.lang.String encoding)
Deprecated.void
setContentParameters(MultiMap<java.lang.String> contentParameters)
Deprecated.void
setContentType(java.lang.String contentType)
Deprecated.void
setContext(ContextHandler.Context context)
Deprecated.Set request contextvoid
setContextPath(java.lang.String contextPath)
Deprecated.Sets the "context path" for this requestvoid
setCookies(Cookie[] cookies)
Deprecated.void
setDispatcherType(DispatcherType type)
Deprecated.void
setHandled(boolean h)
Deprecated.void
setHttpURI(HttpURI uri)
Deprecated.void
setHttpVersion(HttpVersion version)
Deprecated.void
setMetaData(MetaData.Request request)
Deprecated.void
setMethod(java.lang.String method)
Deprecated.void
setPathInfo(java.lang.String pathInfo)
Deprecated.void
setQueryEncoding(java.lang.String queryEncoding)
Deprecated.Set the character encoding used for the query string.void
setQueryParameters(MultiMap<java.lang.String> queryParameters)
Deprecated.void
setQueryString(java.lang.String queryString)
Deprecated.void
setRemoteAddr(java.net.InetSocketAddress addr)
Deprecated.void
setRequestedSessionId(java.lang.String requestedSessionId)
Deprecated.void
setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
Deprecated.void
setScheme(java.lang.String scheme)
Deprecated.void
setSecure(boolean secure)
Deprecated.void
setServletPath(java.lang.String servletPath)
Deprecated.void
setSession(HttpSession session)
Deprecated.void
setSessionHandler(SessionHandler sessionHandler)
Deprecated.void
setTimeStamp(long ts)
Deprecated.void
setURIPathQuery(java.lang.String requestURI)
Deprecated.void
setUserIdentityScope(UserIdentity.Scope scope)
Deprecated.AsyncContext
startAsync()
Deprecated.AsyncContext
startAsync(ServletRequest servletRequest, ServletResponse servletResponse)
Deprecated.boolean
takeNewContext()
Deprecated.java.lang.String
toString()
Deprecated.static HttpServletRequest
unwrap(ServletRequest servletRequest)
Deprecated.<T extends HttpUpgradeHandler>
Tupgrade(java.lang.Class<T> handlerClass)
Deprecated.Start the HTTP upgrade process and create and instance of the provided protocol handler class.
-
-
-
Field Detail
-
MULTIPART_CONFIG_ELEMENT
public static final java.lang.String MULTIPART_CONFIG_ELEMENT
Deprecated.- See Also:
- Constant Field Values
-
MULTIPARTS
public static final java.lang.String MULTIPARTS
Deprecated.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Request
public Request(HttpChannel channel, HttpInput input)
Deprecated.
-
-
Method Detail
-
getBaseRequest
public static Request getBaseRequest(ServletRequest request)
Deprecated.Obtain the baseRequest
instance of aServletRequest
, by coercion, unwrapping or special attribute.- Parameters:
request
- The request- Returns:
- the base
Request
instance of aServletRequest
.
-
getHttpFields
public HttpFields getHttpFields()
Deprecated.
-
getTrailers
public HttpFields getTrailers()
Deprecated.
-
getHttpInput
public HttpInput getHttpInput()
Deprecated.
-
isPush
public boolean isPush()
Deprecated.
-
isPushSupported
public boolean isPushSupported()
Deprecated.
-
getPushBuilder
public PushBuilder getPushBuilder()
Deprecated.Get a PushBuilder associated with this request initialized as follows:- The method is initialized to "GET"
- The headers from this request are copied to the Builder, except for:
- Conditional headers (eg. If-Modified-Since)
- Range headers
- Expect headers
- Authorization headers
- Referrer headers
- If the request was Authenticated, an Authorization header will be set with a container generated token that will result in equivalent Authorization
- The query string from
getQueryString()
- The
getRequestedSessionId()
value, unless at the time of the callgetSession(boolean)
has previously been called to create a newHttpSession
, in which case the new session ID will be used as the PushBuilders requested session ID. - The source of the requested session id will be the same as for this request
- The builders Referer header will be set to
getRequestURL()
plus anygetQueryString()
- If
HttpServletResponse.addCookie(Cookie)
has been called on the associated response, then a corresponding Cookie header will be added to the PushBuilder, unless theCookie.getMaxAge()
is <=0, in which case the Cookie will be removed from the builder. - If this request has has the conditional headers If-Modified-Since or
If-None-Match then the
PushBuilderImpl.isConditional()
header is set to true.
Each call to getPushBuilder() will return a new instance of a PushBuilder based off this Request. Any mutations to the returned PushBuilder are not reflected on future returns.
- Returns:
- A new PushBuilder or null if push is not supported
-
addEventListener
public void addEventListener(java.util.EventListener listener)
Deprecated.
-
enterSession
public void enterSession(HttpSession s)
Deprecated.Remember a session that this request has just entered.- Parameters:
s
- the session
-
extractFormParameters
public void extractFormParameters(MultiMap<java.lang.String> params)
Deprecated.
-
getAsyncContext
public AsyncContext getAsyncContext()
Deprecated.Description copied from interface:ServletRequest
Get the current AsyncContext.- Specified by:
getAsyncContext
in interfaceServletRequest
- Returns:
- The current AsyncContext
-
getHttpChannelState
public HttpChannelState getHttpChannelState()
Deprecated.
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
Deprecated.Get Request Attribute.Also supports jetty specific attributes to gain access to Jetty APIs:
- org.eclipse.jetty.server.Server
- The Jetty Server instance
- org.eclipse.jetty.server.HttpChannel
- The HttpChannel for this request
- org.eclipse.jetty.server.HttpConnection
- The HttpConnection or null if another transport is used
- Specified by:
getAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attribute- Returns:
- an
Object
containing the value of the attribute, ornull
if the attribute does not exist - See Also:
ServletRequest.getAttribute(java.lang.String)
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
Deprecated.Description copied from interface:ServletRequest
Returns anEnumeration
containing the names of the attributes available to this request. This method returns an emptyEnumeration
if the request has no attributes available to it.- Specified by:
getAttributeNames
in interfaceServletRequest
- Returns:
- an
Enumeration
of strings containing the names of the request's attributes
-
getAttributes
public Attributes getAttributes()
Deprecated.
-
getAuthentication
public Authentication getAuthentication()
Deprecated.Get the authentication.- Returns:
- the authentication
-
getAuthType
public java.lang.String getAuthType()
Deprecated.Description copied from interface:HttpServletRequest
Returns the name of the authentication scheme used to protect the servlet. All servlet containers support basic, form and client certificate authentication, and may additionally support digest authentication. If the servlet is not authenticatednull
is returned.Same as the value of the CGI variable AUTH_TYPE.
- Specified by:
getAuthType
in 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
null
if the request was not authenticated.
-
getCharacterEncoding
public java.lang.String getCharacterEncoding()
Deprecated.Description copied from interface:ServletRequest
Returns the name of the character encoding used in the body of this request. This method returnsnull
if the request does not specify a character encoding- Specified by:
getCharacterEncoding
in interfaceServletRequest
- Returns:
- a
String
containing the name of the character encoding, ornull
if the request does not specify a character encoding
-
getHttpChannel
public HttpChannel getHttpChannel()
Deprecated.- Returns:
- Returns the connection.
-
getContentLength
public int getContentLength()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getContentLength
in interfaceServletRequest
- Returns:
- an integer containing the length of the request body or -1 if the
length is not known or is greater than
Integer.MAX_VALUE
-
getContentLengthLong
public long getContentLengthLong()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getContentLengthLong
in interfaceServletRequest
- Returns:
- a long integer containing the length of the request body or -1 if the length is not known
-
getContentRead
public long getContentRead()
Deprecated.
-
getContentType
public java.lang.String getContentType()
Deprecated.Description copied from interface:ServletRequest
Returns the MIME type of the body of the request, ornull
if the type is not known. For HTTP servlets, same as the value of the CGI variable CONTENT_TYPE.- Specified by:
getContentType
in interfaceServletRequest
- Returns:
- a
String
containing the name of the MIME type of the request, or null if the type is not known
-
getContext
public ContextHandler.Context getContext()
Deprecated.- Returns:
- The current
context
used for this request, ornull
ifsetContext(org.eclipse.jetty.server.handler.ContextHandler.Context)
has not yet been called.
-
getErrorContext
public ContextHandler.Context getErrorContext()
Deprecated.- Returns:
- The current
context
used for this error handling for this request. If the request is asynchronous, then it is the context that called async. Otherwise it is the last non-null context passed to #setContext
-
getContextPath
public java.lang.String getContextPath()
Deprecated.Description copied from interface:HttpServletRequest
Returns the portion of the request URI that indicates the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "". The container does not decode this string.- Specified by:
getContextPath
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the portion of the request URI that indicates the context of the request
-
getCookies
public Cookie[] getCookies()
Deprecated.Description copied from interface:HttpServletRequest
Returns an array containing all of theCookie
objects the client sent with this request. This method returnsnull
if no cookies were sent.- Specified by:
getCookies
in interfaceHttpServletRequest
- Returns:
- an array of all the
Cookies
included with this request, ornull
if the request has no cookies
-
getDateHeader
public long getDateHeader(java.lang.String name)
Deprecated.Description copied from interface:HttpServletRequest
Returns the value of the specified request header as along
value that represents aDate
object. Use this method with headers that contain dates, such asIf-Modified-Since
.The date is returned as the number of milliseconds since January 1, 1970 GMT. The header name is case insensitive.
If the request did not have a header of the specified name, this method returns -1. If the header can't be converted to a date, the method throws an
IllegalArgumentException
.- Specified by:
getDateHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the name of the header- Returns:
- a
long
value representing the date specified in the header expressed as the number of milliseconds since January 1, 1970 GMT, or -1 if the named header was not included with the request
-
getDispatcherType
public DispatcherType getDispatcherType()
Deprecated.- Specified by:
getDispatcherType
in interfaceServletRequest
- Returns:
- TODO
-
getHeader
public java.lang.String getHeader(java.lang.String name)
Deprecated.Description copied from interface:HttpServletRequest
Returns the value of the specified request header as aString
. If the request did not include a header of the specified name, this method returnsnull
. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.- Specified by:
getHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- a
String
containing the value of the requested header, ornull
if the request does not have a header of that name
-
getHeaderNames
public java.util.Enumeration<java.lang.String> getHeaderNames()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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:
getHeaderNames
in interfaceHttpServletRequest
- Returns:
- an enumeration of all the header names sent with this request; if
the request has no headers, an empty enumeration; if the servlet
container does not allow servlets to use this method,
null
-
getHeaders
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
Deprecated.Description copied from interface:HttpServletRequest
Returns all the values of the specified request header as anEnumeration
ofString
objects.Some headers, such as
Accept-Language
can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.If the request did not include any headers of the specified name, this method returns an empty
Enumeration
. The header name is case insensitive. You can use this method with any request header.- Specified by:
getHeaders
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the header name- Returns:
- an
Enumeration
containing the values of the requested header. If the request does not have any headers of that name return an empty enumeration. If the container does not allow access to header information, return null
-
getInputState
public int getInputState()
Deprecated.- Returns:
- Returns the inputState.
-
getInputStream
public ServletInputStream getInputStream() throws java.io.IOException
Deprecated.Description copied from interface:ServletRequest
Retrieves 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:
getInputStream
in interfaceServletRequest
- Returns:
- a
ServletInputStream
object containing the body of the request - Throws:
java.io.IOException
- if an input or output exception occurred
-
getIntHeader
public int getIntHeader(java.lang.String name)
Deprecated.Description copied from interface:HttpServletRequest
Returns the value of the specified request header as anint
. If the request does not have a header of the specified name, this method returns -1. If the header cannot be converted to an integer, this method throws aNumberFormatException
.The header name is case insensitive.
- Specified by:
getIntHeader
in interfaceHttpServletRequest
- Parameters:
name
- aString
specifying the name of a request header- Returns:
- an integer expressing the value of the request header or -1 if the request doesn't have a header of this name
-
getLocale
public java.util.Locale getLocale()
Deprecated.Description copied from interface:ServletRequest
Returns the preferredLocale
that 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:
getLocale
in interfaceServletRequest
- Returns:
- the preferred
Locale
for the client
-
getLocales
public java.util.Enumeration<java.util.Locale> getLocales()
Deprecated.Description copied from interface:ServletRequest
Returns anEnumeration
ofLocale
objects 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 anEnumeration
containing oneLocale
, the default locale for the server.- Specified by:
getLocales
in interfaceServletRequest
- Returns:
- an
Enumeration
of preferredLocale
objects for the client
-
getLocalAddr
public java.lang.String getLocalAddr()
Deprecated.Description copied from interface:ServletRequest
Returns the Internet Protocol (IP) address of the interface on which the request was received.- Specified by:
getLocalAddr
in interfaceServletRequest
- Returns:
- a
String
containing the IP address on which the request was received.
-
getLocalName
public java.lang.String getLocalName()
Deprecated.Description copied from interface:ServletRequest
Returns the host name of the Internet Protocol (IP) interface on which the request was received.- Specified by:
getLocalName
in interfaceServletRequest
- Returns:
- a
String
containing the host name of the IP on which the request was received.
-
getLocalPort
public int getLocalPort()
Deprecated.Description copied from interface:ServletRequest
Returns the Internet Protocol (IP) port number of the interface on which the request was received.- Specified by:
getLocalPort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
-
getMethod
public java.lang.String getMethod()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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:
getMethod
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the name of the method with which this request was made
-
getParameter
public java.lang.String getParameter(java.lang.String name)
Deprecated.Description copied from interface:ServletRequest
Returns the value of a request parameter as aString
, ornull
if 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:
getParameter
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the parameter- Returns:
- a
String
representing the single value of the parameter - See Also:
ServletRequest.getParameterValues(java.lang.String)
-
getParameterMap
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
Deprecated.Description copied from interface:ServletRequest
Returns a java.util.Map of 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:
getParameterMap
in interfaceServletRequest
- Returns:
- an immutable java.util.Map containing parameter names as keys and parameter values as map values. The keys in the parameter map are of type String. The values in the parameter map are of type String array.
-
getParameterNames
public java.util.Enumeration<java.lang.String> getParameterNames()
Deprecated.Description copied from interface:ServletRequest
Returns anEnumeration
ofString
objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an emptyEnumeration
.- Specified by:
getParameterNames
in interfaceServletRequest
- Returns:
- an
Enumeration
ofString
objects, eachString
containing the name of a request parameter; or an emptyEnumeration
if the request has no parameters
-
getParameterValues
public java.lang.String[] getParameterValues(java.lang.String name)
Deprecated.Description copied from interface:ServletRequest
Returns an array ofString
objects containing all of the values the given request parameter has, ornull
if the parameter does not exist.If the parameter has a single value, the array has a length of 1.
- Specified by:
getParameterValues
in interfaceServletRequest
- Parameters:
name
- aString
containing the name of the parameter whose value is requested- Returns:
- an array of
String
objects containing the parameter's values - See Also:
ServletRequest.getParameter(java.lang.String)
-
getQueryParameters
public MultiMap<java.lang.String> getQueryParameters()
Deprecated.
-
setQueryParameters
public void setQueryParameters(MultiMap<java.lang.String> queryParameters)
Deprecated.
-
setContentParameters
public void setContentParameters(MultiMap<java.lang.String> contentParameters)
Deprecated.
-
resetParameters
public void resetParameters()
Deprecated.
-
getPathInfo
public java.lang.String getPathInfo()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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
null
if there was no extra path information.Same as the value of the CGI variable PATH_INFO.
- Specified by:
getPathInfo
in interfaceHttpServletRequest
- Returns:
- a
String
, decoded by the web container, specifying extra path information that comes after the servlet path but before the query string in the request URL; ornull
if the URL does not have any extra path information
-
getPathTranslated
public java.lang.String getPathTranslated()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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
null
or 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:
getPathTranslated
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the real path, ornull
if the URL does not have any extra path information
-
getProtocol
public java.lang.String getProtocol()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getProtocol
in interfaceServletRequest
- Returns:
- a
String
containing the protocol name and version number
-
getHttpVersion
public HttpVersion getHttpVersion()
Deprecated.
-
getQueryEncoding
public java.lang.String getQueryEncoding()
Deprecated.
-
getQueryString
public java.lang.String getQueryString()
Deprecated.Description copied from interface:HttpServletRequest
Returns the query string that is contained in the request URL after the path. This method returnsnull
if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING.- Specified by:
getQueryString
in interfaceHttpServletRequest
- Returns:
- a
String
containing the query string ornull
if the URL contains no query string. The value is not decoded by the container.
-
getReader
public java.io.BufferedReader getReader() throws java.io.IOException
Deprecated.Description copied from interface:ServletRequest
Retrieves the body of the request as character data using aBufferedReader
. The reader translates the character data according to the character encoding used on the body. Either this method orServletRequest.getInputStream()
may be called to read the body, not both.- Specified by:
getReader
in interfaceServletRequest
- Returns:
- a
BufferedReader
containing the body of the request - Throws:
java.io.UnsupportedEncodingException
- if the character set encoding used is not supported and the text cannot be decodedjava.io.IOException
- if an input or output exception occurred- See Also:
ServletRequest.getInputStream()
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Deprecated.- Specified by:
getRealPath
in interfaceServletRequest
- Parameters:
path
- The virtual path to be converted to a real path- Returns:
ServletContext.getRealPath(String)
-
getRemoteInetSocketAddress
public java.net.InetSocketAddress getRemoteInetSocketAddress()
Deprecated.Access the underlying RemoteInetSocketAddress
for this request.- Returns:
- the remote
InetSocketAddress
for this request, or null if the request has no remote (seeServletRequest.getRemoteAddr()
for conditions that result in no remote address)
-
getRemoteAddr
public java.lang.String getRemoteAddr()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getRemoteAddr
in interfaceServletRequest
- Returns:
- a
String
containing the IP address of the client that sent the request
-
getRemoteHost
public java.lang.String getRemoteHost()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getRemoteHost
in interfaceServletRequest
- Returns:
- a
String
containing the fully qualified name of the client
-
getRemotePort
public int getRemotePort()
Deprecated.Description copied from interface:ServletRequest
Returns the Internet Protocol (IP) source port of the client or last proxy that sent the request.- Specified by:
getRemotePort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
-
getRemoteUser
public java.lang.String getRemoteUser()
Deprecated.Description copied from interface:HttpServletRequest
Returns the login of the user making this request, if the user has been authenticated, ornull
if 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:
getRemoteUser
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the login of the user making this request, ornull
if the user login is not known
-
getRequestDispatcher
public RequestDispatcher getRequestDispatcher(java.lang.String path)
Deprecated.Description copied from interface:ServletRequest
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
object 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
null
if 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:
getRequestDispatcher
in interfaceServletRequest
- Parameters:
path
- aString
specifying the pathname to the resource. If it is relative, it must be relative against the current servlet.- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if the servlet container cannot return aRequestDispatcher
- See Also:
RequestDispatcher
,ServletContext.getRequestDispatcher(java.lang.String)
-
getRequestedSessionId
public java.lang.String getRequestedSessionId()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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:
getRequestedSessionId
in interfaceHttpServletRequest
- Returns:
- a
String
specifying the session ID, ornull
if the request did not specify a session ID - See Also:
HttpServletRequest.isRequestedSessionIdValid()
-
getRequestURI
public java.lang.String getRequestURI()
Deprecated.Description copied from interface:HttpServletRequest
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. 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:
getRequestURI
in interfaceHttpServletRequest
- Returns:
- a
String
containing the part of the URL from the protocol name up to the query string - See Also:
HttpServletRequest.getRequestURL()
-
getRequestURL
public java.lang.StringBuffer getRequestURL()
Deprecated.Description copied from interface:HttpServletRequest
Reconstructs 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:
getRequestURL
in interfaceHttpServletRequest
- Returns:
- a
StringBuffer
object containing the reconstructed URL
-
getResponse
public Response getResponse()
Deprecated.
-
getRootURL
public java.lang.StringBuilder getRootURL()
Deprecated.Reconstructs the URL the client used to make the request. The returned URL contains a protocol, server name, port number, and, but it does not include a path.Because this method returns a
StringBuffer
, not a string, you can modify the URL easily, for example, to append path and query parameters. This method is useful for creating redirect messages and for reporting errors.- Returns:
- "scheme://host:port"
-
getScheme
public java.lang.String getScheme()
Deprecated.Description copied from interface:ServletRequest
Returns 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:
getScheme
in interfaceServletRequest
- Returns:
- a
String
containing the name of the scheme used to make this request
-
getServerName
public java.lang.String getServerName()
Deprecated.Description copied from interface:ServletRequest
Returns the host name of the server to which the request was sent. It is the value of the part before ":" in theHost
header value, if any, or the resolved server name, or the server IP address.- Specified by:
getServerName
in interfaceServletRequest
- Returns:
- a
String
containing the name of the server
-
getServerPort
public int getServerPort()
Deprecated.Description copied from interface:ServletRequest
Returns the port number to which the request was sent. It is the value of the part after ":" in theHost
header value, if any, or the server port where the client connection was accepted on.- Specified by:
getServerPort
in interfaceServletRequest
- Returns:
- an integer specifying the port number
-
getServletContext
public ServletContext getServletContext()
Deprecated.- Specified by:
getServletContext
in interfaceServletRequest
- Returns:
- TODO
-
getServletName
public java.lang.String getServletName()
Deprecated.
-
getServletPath
public java.lang.String getServletPath()
Deprecated.Description copied from interface:HttpServletRequest
Returns 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.This method will return an empty string ("") if the servlet used to process this request was matched using the "/*" pattern.
- Specified by:
getServletPath
in interfaceHttpServletRequest
- Returns:
- a
String
containing the name or path of the servlet being called, as specified in the request URL, decoded, or an empty string if the servlet used to process the request is matched using the "/*" pattern.
-
getServletResponse
public ServletResponse getServletResponse()
Deprecated.
-
changeSessionId
public java.lang.String changeSessionId()
Deprecated.Description copied from interface:HttpServletRequest
Changes 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:
changeSessionId
in interfaceHttpServletRequest
- Returns:
- the new session ID allocated to the session
- See Also:
HttpSessionIdListener
-
onCompleted
public void onCompleted()
Deprecated.Called when the request is fully finished being handled. For every session in any context that the session has accessed, ensure that the session is completed.
-
onResponseCommit
public void onResponseCommit()
Deprecated.Called when a response is about to be committed, ie sent back to the client
-
getSession
public HttpSession getSession(SessionHandler sessionHandler)
Deprecated.Find a session that this request has already entered for the given SessionHandler- Parameters:
sessionHandler
- the SessionHandler (ie context) to check- Returns:
-
getSession
public HttpSession getSession()
Deprecated.Description copied from interface:HttpServletRequest
Returns the current session associated with this request, or if the request does not have a session, creates one.- Specified by:
getSession
in interfaceHttpServletRequest
- Returns:
- the
HttpSession
associated with this request - See Also:
HttpServletRequest.getSession(boolean)
-
getSession
public HttpSession getSession(boolean create)
Deprecated.Description copied from interface:HttpServletRequest
Returns the currentHttpSession
associated with this request or, if there is no current session andcreate
is true, returns a new session.If
create
isfalse
and 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:
getSession
in interfaceHttpServletRequest
- Parameters:
create
-true
to create a new session for this request if necessary;false
to returnnull
if there's no current session- Returns:
- the
HttpSession
associated with this request ornull
ifcreate
isfalse
and the request has no valid session - See Also:
HttpServletRequest.getSession()
-
getSessionHandler
public SessionHandler getSessionHandler()
Deprecated.- Returns:
- Returns the sessionManager.
-
getTimeStamp
public long getTimeStamp()
Deprecated.Get Request TimeStamp- Returns:
- The time that the request was received.
-
getHttpURI
public HttpURI getHttpURI()
Deprecated.- Returns:
- Returns the uri.
-
getOriginalURI
public java.lang.String getOriginalURI()
Deprecated.- Returns:
- Returns the original uri passed in metadata before customization/rewrite
-
setHttpURI
public void setHttpURI(HttpURI uri)
Deprecated.- Parameters:
uri
- the URI to set
-
getUserIdentity
public UserIdentity getUserIdentity()
Deprecated.
-
getResolvedUserIdentity
public UserIdentity getResolvedUserIdentity()
Deprecated.- Returns:
- The resolved user Identity, which may be null if the
Authentication
is notAuthentication.User
(eg.Authentication.Deferred
).
-
getUserIdentityScope
public UserIdentity.Scope getUserIdentityScope()
Deprecated.
-
getUserPrincipal
public java.security.Principal getUserPrincipal()
Deprecated.Description copied from interface:HttpServletRequest
Returns ajava.security.Principal
object containing the name of the current authenticated user. If the user has not been authenticated, the method returnsnull
.- Specified by:
getUserPrincipal
in interfaceHttpServletRequest
- Returns:
- a
java.security.Principal
containing the name of the user making this request;null
if the user has not been authenticated
-
isHandled
public boolean isHandled()
Deprecated.
-
isAsyncStarted
public boolean isAsyncStarted()
Deprecated.- Specified by:
isAsyncStarted
in interfaceServletRequest
- Returns:
- TODO
-
isAsyncSupported
public boolean isAsyncSupported()
Deprecated.- Specified by:
isAsyncSupported
in interfaceServletRequest
- Returns:
- TODO
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
Deprecated.Description copied from interface:HttpServletRequest
Checks whether the requested session ID came in as a cookie.- Specified by:
isRequestedSessionIdFromCookie
in interfaceHttpServletRequest
- Returns:
true
if the session ID came in as a cookie; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdFromUrl
public boolean isRequestedSessionIdFromUrl()
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfaceHttpServletRequest
- Returns:
HttpServletRequest.isRequestedSessionIdFromURL()
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
Deprecated.Description copied from interface:HttpServletRequest
Checks whether the requested session ID came in as part of the request URL.- Specified by:
isRequestedSessionIdFromURL
in interfaceHttpServletRequest
- Returns:
true
if the session ID came in as part of a URL; otherwise,false
- See Also:
HttpServletRequest.getSession(boolean)
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
Deprecated.Description copied from interface:HttpServletRequest
Checks whether the requested session ID is still valid.- Specified by:
isRequestedSessionIdValid
in interfaceHttpServletRequest
- Returns:
true
if this request has an id for a valid session in the current session context;false
otherwise- See Also:
HttpServletRequest.getRequestedSessionId()
,HttpServletRequest.getSession(boolean)
-
isSecure
public boolean isSecure()
Deprecated.Description copied from interface:ServletRequest
Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.- Specified by:
isSecure
in interfaceServletRequest
- Returns:
- a boolean indicating if the request was made using a secure channel
-
setSecure
public void setSecure(boolean secure)
Deprecated.
-
isUserInRole
public boolean isUserInRole(java.lang.String role)
Deprecated.Description copied from interface:HttpServletRequest
Returns 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:
isUserInRole
in interfaceHttpServletRequest
- Parameters:
role
- aString
specifying the name of the role- Returns:
- a
boolean
indicating whether the user making this request belongs to a given role;false
if the user has not been authenticated
-
setMetaData
public void setMetaData(MetaData.Request request)
Deprecated.- Parameters:
request
- the Request metadata
-
getMetaData
public MetaData.Request getMetaData()
Deprecated.
-
hasMetaData
public boolean hasMetaData()
Deprecated.
-
removeAttribute
public void removeAttribute(java.lang.String name)
Deprecated.Description copied from interface:ServletRequest
Removes an attribute from this request. This method is not generally needed as attributes only persist as long as the request is being handled.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:
removeAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attribute to remove
-
removeEventListener
public void removeEventListener(java.util.EventListener listener)
Deprecated.
-
setAsyncSupported
public void setAsyncSupported(boolean supported, java.lang.Object source)
Deprecated.
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)
Deprecated.Description copied from interface:ServletRequest
Stores an attribute in this request. Attributes are reset between requests. This method is most often used in conjunction withRequestDispatcher
.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.
If the object passed in is null, the effect is the same as callingServletRequest.removeAttribute(java.lang.String)
.
It is warned that when the request is dispatched from the servlet resides in a different web application byRequestDispatcher
, the object set by this method may not be correctly retrieved in the caller servlet.- Specified by:
setAttribute
in interfaceServletRequest
- Parameters:
name
- aString
specifying the name of the attributevalue
- theObject
to be stored
-
setAttributes
public void setAttributes(Attributes attributes)
Deprecated.
-
setAsyncAttributes
public void setAsyncAttributes()
Deprecated.
-
setAuthentication
public void setAuthentication(Authentication authentication)
Deprecated.Set the authentication.- Parameters:
authentication
- the authentication to set
-
setCharacterEncoding
public void setCharacterEncoding(java.lang.String encoding) throws java.io.UnsupportedEncodingException
Deprecated.Description copied from interface:ServletRequest
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 using getReader().- Specified by:
setCharacterEncoding
in interfaceServletRequest
- Parameters:
encoding
- aString
containing the name of the character encoding.- Throws:
java.io.UnsupportedEncodingException
- if this is not a valid encoding
-
setCharacterEncodingUnchecked
public void setCharacterEncodingUnchecked(java.lang.String encoding)
Deprecated.
-
setContentType
public void setContentType(java.lang.String contentType)
Deprecated.
-
setContext
public void setContext(ContextHandler.Context context)
Deprecated.Set request context- Parameters:
context
- context object
-
takeNewContext
public boolean takeNewContext()
Deprecated.- Returns:
- True if this is the first call of
takeNewContext()
since the lastsetContext(org.eclipse.jetty.server.handler.ContextHandler.Context)
call.
-
setContextPath
public void setContextPath(java.lang.String contextPath)
Deprecated.Sets the "context path" for this request- Parameters:
contextPath
- the context path for this request- See Also:
HttpServletRequest.getContextPath()
-
setCookies
public void setCookies(Cookie[] cookies)
Deprecated.- Parameters:
cookies
- The cookies to set.
-
setDispatcherType
public void setDispatcherType(DispatcherType type)
Deprecated.
-
setHandled
public void setHandled(boolean h)
Deprecated.
-
setMethod
public void setMethod(java.lang.String method)
Deprecated.- Parameters:
method
- The method to set.
-
setHttpVersion
public void setHttpVersion(HttpVersion version)
Deprecated.
-
isHead
public boolean isHead()
Deprecated.
-
setPathInfo
public void setPathInfo(java.lang.String pathInfo)
Deprecated.- Parameters:
pathInfo
- The pathInfo to set.
-
setQueryEncoding
public void setQueryEncoding(java.lang.String queryEncoding)
Deprecated.Set the character encoding used for the query string. This call will effect the return of getQueryString and getParamaters. It must be called before any getParameter methods. The request attribute "org.eclipse.jetty.server.Request.queryEncoding" may be set as an alternate method of calling setQueryEncoding.- Parameters:
queryEncoding
- the URI query character encoding
-
setQueryString
public void setQueryString(java.lang.String queryString)
Deprecated.- Parameters:
queryString
- The queryString to set.
-
setRemoteAddr
public void setRemoteAddr(java.net.InetSocketAddress addr)
Deprecated.- Parameters:
addr
- The address to set.
-
setRequestedSessionId
public void setRequestedSessionId(java.lang.String requestedSessionId)
Deprecated.- Parameters:
requestedSessionId
- The requestedSessionId to set.
-
setRequestedSessionIdFromCookie
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
Deprecated.- Parameters:
requestedSessionIdCookie
- The requestedSessionIdCookie to set.
-
setURIPathQuery
public void setURIPathQuery(java.lang.String requestURI)
Deprecated.
-
setScheme
public void setScheme(java.lang.String scheme)
Deprecated.- Parameters:
scheme
- The scheme to set.
-
setAuthority
public void setAuthority(java.lang.String host, int port)
Deprecated.- Parameters:
host
- The host to set.port
- the port to set
-
setServletPath
public void setServletPath(java.lang.String servletPath)
Deprecated.- Parameters:
servletPath
- The servletPath to set.
-
setSession
public void setSession(HttpSession session)
Deprecated.- Parameters:
session
- The session to set.
-
setSessionHandler
public void setSessionHandler(SessionHandler sessionHandler)
Deprecated.- Parameters:
sessionHandler
- The SessionHandler to set.
-
setTimeStamp
public void setTimeStamp(long ts)
Deprecated.
-
setUserIdentityScope
public void setUserIdentityScope(UserIdentity.Scope scope)
Deprecated.
-
startAsync
public AsyncContext startAsync() throws java.lang.IllegalStateException
Deprecated.- Specified by:
startAsync
in interfaceServletRequest
- Returns:
- TODO
- Throws:
java.lang.IllegalStateException
- If async is not supported for this request
-
startAsync
public AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) throws java.lang.IllegalStateException
Deprecated.- Specified by:
startAsync
in interfaceServletRequest
- Parameters:
servletRequest
- The ServletRequest with which to initialise the asynchronous contextservletResponse
- The ServletResponse with which to initialise the asynchronous context- Returns:
- TODO
- Throws:
java.lang.IllegalStateException
- If async is not supported for this request
-
unwrap
public static HttpServletRequest unwrap(ServletRequest servletRequest)
Deprecated.
-
toString
public java.lang.String toString()
Deprecated.- Overrides:
toString
in classjava.lang.Object
-
authenticate
public boolean authenticate(HttpServletResponse response) throws java.io.IOException, ServletException
Deprecated.Description copied from interface:HttpServletRequest
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:
authenticate
in interfaceHttpServletRequest
- Parameters:
response
- The response to use to return any authentication challenge- Returns:
true
if the user is successfully authenticated andfalse
if not- Throws:
java.io.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
-
getPart
public Part getPart(java.lang.String name) throws java.io.IOException, ServletException
Deprecated.Description copied from interface:HttpServletRequest
Gets the named Part or null if the Part does not exist. Triggers upload of all Parts.- Specified by:
getPart
in interfaceHttpServletRequest
- Parameters:
name
- The name of the Part to obtain- Returns:
- The named Part or null if the Part does not exist
- Throws:
java.io.IOException
- if an I/O error occursServletException
- if the request is not multipart/form-data
-
getParts
public java.util.Collection<Part> getParts() throws java.io.IOException, ServletException
Deprecated.Description copied from interface:HttpServletRequest
Return a collection of all uploaded Parts.- Specified by:
getParts
in interfaceHttpServletRequest
- Returns:
- A collection of all uploaded Parts.
- Throws:
java.io.IOException
- if an I/O error occursServletException
- if the request is not multipart/form-data
-
login
public void login(java.lang.String username, java.lang.String password) throws ServletException
Deprecated.Description copied from interface:HttpServletRequest
Authenticate the provided user name and password and then associated the authenticated user with the request.- Specified by:
login
in 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 ServletException
Deprecated.Description copied from interface:HttpServletRequest
Removes any authenticated user from the request.- Specified by:
logout
in interfaceHttpServletRequest
- Throws:
ServletException
- If the logout fails
-
mergeQueryParameters
public void mergeQueryParameters(java.lang.String oldQuery, java.lang.String newQuery, boolean updateQueryString)
Deprecated.
-
upgrade
public <T extends HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass) throws java.io.IOException, ServletException
Deprecated.Description copied from interface:HttpServletRequest
Start 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:
upgrade
in interfaceHttpServletRequest
- Type Parameters:
T
- The type of the upgrade handler- Parameters:
handlerClass
- The class that implements the upgrade handler- Returns:
- A newly created instance of the specified upgrade handler type
- Throws:
java.io.IOException
- if an I/O error occurred during the upgradeServletException
- if the given httpUpgradeHandlerClass fails to be instantiated- See Also:
HttpServletRequest.upgrade(java.lang.Class)
-
-