- java.lang.Object
-
- org.eclipse.jetty.server.Request
-
- All Implemented Interfaces:
javax.servlet.http.HttpServletRequest
,javax.servlet.ServletRequest
public class Request extends java.lang.Object implements javax.servlet.http.HttpServletRequest
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 callssetContext(Context,String)
as a result. For some dispatch types (ie include and named dispatch) the context path may not reflect theServletContext
set bysetContext(Context, String)
. - 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 "" until the request has been passed to aorg.eclipse.jetty.servlet.ServletHandler
and the pathInfo matched against the servlet URL patterns andsetServletPathMapping(ServletPathMapping)
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
-
Constructor Summary
Constructors Constructor Description Request(HttpChannel channel, HttpInput input)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addEventListener(java.util.EventListener listener)
boolean
authenticate(javax.servlet.http.HttpServletResponse response)
java.lang.String
changeSessionId()
void
enterSession(javax.servlet.http.HttpSession s)
Remember a session that this request has just entered.void
extractFormParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> params)
javax.servlet.AsyncContext
getAsyncContext()
java.lang.Object
getAttribute(java.lang.String name)
Get Request Attribute.java.util.Enumeration<java.lang.String>
getAttributeNames()
org.eclipse.jetty.util.Attributes
getAttributes()
Authentication
getAuthentication()
Get the authentication.java.lang.String
getAuthType()
static Request
getBaseRequest(javax.servlet.ServletRequest request)
Obtain the baseRequest
instance of aServletRequest
, by coercion, unwrapping or special attribute.java.lang.String
getCharacterEncoding()
org.eclipse.jetty.http.ComplianceViolation.Listener
getComplianceViolationListener()
int
getContentLength()
long
getContentLengthLong()
long
getContentRead()
java.lang.String
getContentType()
ContextHandler.Context
getContext()
java.lang.String
getContextPath()
javax.servlet.http.Cookie[]
getCookies()
long
getDateHeader(java.lang.String name)
javax.servlet.DispatcherType
getDispatcherType()
ContextHandler.Context
getErrorContext()
java.lang.String
getHeader(java.lang.String name)
java.util.Enumeration<java.lang.String>
getHeaderNames()
java.util.Enumeration<java.lang.String>
getHeaders(java.lang.String name)
HttpChannel
getHttpChannel()
HttpChannelState
getHttpChannelState()
org.eclipse.jetty.http.HttpFields
getHttpFields()
HttpInput
getHttpInput()
javax.servlet.http.HttpServletMapping
getHttpServletMapping()
org.eclipse.jetty.http.HttpURI
getHttpURI()
org.eclipse.jetty.http.HttpVersion
getHttpVersion()
int
getInputState()
javax.servlet.ServletInputStream
getInputStream()
int
getIntHeader(java.lang.String name)
java.lang.String
getLocalAddr()
java.util.Locale
getLocale()
java.util.Enumeration<java.util.Locale>
getLocales()
java.lang.String
getLocalName()
int
getLocalPort()
org.eclipse.jetty.http.MetaData.Request
getMetaData()
java.lang.String
getMethod()
java.lang.String
getOriginalURI()
java.lang.String
getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String[]>
getParameterMap()
java.util.Enumeration<java.lang.String>
getParameterNames()
java.lang.String[]
getParameterValues(java.lang.String name)
javax.servlet.http.Part
getPart(java.lang.String name)
java.util.Collection<javax.servlet.http.Part>
getParts()
java.lang.String
getPathInContext()
Get the path in the context.java.lang.String
getPathInfo()
java.lang.String
getPathTranslated()
java.lang.String
getProtocol()
java.lang.String
getQueryEncoding()
org.eclipse.jetty.util.MultiMap<java.lang.String>
getQueryParameters()
java.lang.String
getQueryString()
java.io.BufferedReader
getReader()
java.lang.String
getRealPath(java.lang.String path)
Deprecated.java.lang.String
getRemoteAddr()
java.lang.String
getRemoteHost()
java.net.InetSocketAddress
getRemoteInetSocketAddress()
Access the underlying RemoteInetSocketAddress
for this request.int
getRemotePort()
java.lang.String
getRemoteUser()
javax.servlet.RequestDispatcher
getRequestDispatcher(java.lang.String path)
java.lang.String
getRequestedSessionId()
java.lang.String
getRequestURI()
java.lang.StringBuffer
getRequestURL()
UserIdentity
getResolvedUserIdentity()
Response
getResponse()
java.lang.StringBuilder
getRootURL()
Reconstructs the URL the client used to make the request.java.lang.String
getScheme()
java.lang.String
getServerName()
int
getServerPort()
javax.servlet.ServletContext
getServletContext()
java.lang.String
getServletName()
java.lang.String
getServletPath()
ServletPathMapping
getServletPathMapping()
javax.servlet.ServletResponse
getServletResponse()
javax.servlet.http.HttpSession
getSession()
javax.servlet.http.HttpSession
getSession(boolean create)
javax.servlet.http.HttpSession
getSession(SessionHandler sessionHandler)
Find a session that this request has already entered for the given SessionHandlerSessionHandler
getSessionHandler()
long
getTimeStamp()
Get Request TimeStampjava.util.Map<java.lang.String,java.lang.String>
getTrailerFields()
org.eclipse.jetty.http.HttpFields
getTrailerHttpFields()
UserIdentity
getUserIdentity()
UserIdentity.Scope
getUserIdentityScope()
java.security.Principal
getUserPrincipal()
boolean
hasMetaData()
boolean
isAsyncStarted()
boolean
isAsyncSupported()
boolean
isHandled()
boolean
isHead()
boolean
isPush()
boolean
isPushSupported()
boolean
isRequestedSessionIdFromCookie()
boolean
isRequestedSessionIdFromUrl()
Deprecated.boolean
isRequestedSessionIdFromURL()
boolean
isRequestedSessionIdValid()
boolean
isSecure()
boolean
isUserInRole(java.lang.String role)
void
login(java.lang.String username, java.lang.String password)
void
logout()
void
mergeQueryParameters(java.lang.String oldQuery, java.lang.String newQuery)
javax.servlet.http.PushBuilder
newPushBuilder()
void
onCompleted()
Called when the request is fully finished being handled.void
onResponseCommit()
Called when a response is about to be committed, ie sent back to the clientprotected void
recycle()
void
removeAttribute(java.lang.String name)
void
removeEventListener(java.util.EventListener listener)
void
resetParameters()
void
setAsyncAttributes()
void
setAsyncSupported(boolean supported, java.lang.Object source)
void
setAttribute(java.lang.String name, java.lang.Object value)
Set a request attribute.void
setAttributes(org.eclipse.jetty.util.Attributes attributes)
Set the attributes for the request.void
setAuthentication(Authentication authentication)
Set the authentication.void
setCharacterEncoding(java.lang.String encoding)
void
setCharacterEncodingUnchecked(java.lang.String encoding)
void
setContentParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> contentParameters)
void
setContentType(java.lang.String contentType)
void
setContext(ContextHandler.Context context, java.lang.String pathInContext)
Set request context and path in the context.void
setCookies(javax.servlet.http.Cookie[] cookies)
void
setDispatcherType(javax.servlet.DispatcherType type)
void
setHandled(boolean h)
void
setHttpFields(org.eclipse.jetty.http.HttpFields fields)
void
setHttpURI(org.eclipse.jetty.http.HttpURI uri)
void
setMetaData(org.eclipse.jetty.http.MetaData.Request request)
void
setMethod(java.lang.String method)
void
setQueryEncoding(java.lang.String queryEncoding)
Set the character encoding used for the query string.void
setQueryParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> queryParameters)
void
setRemoteAddr(java.net.InetSocketAddress addr)
void
setRequestedSessionId(java.lang.String requestedSessionId)
void
setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
void
setSecure(boolean secure)
void
setServletPathMapping(ServletPathMapping servletPathMapping)
Set the servletPathMapping, the servletPath and the pathInfo.void
setSession(javax.servlet.http.HttpSession session)
void
setSessionHandler(SessionHandler sessionHandler)
void
setTimeStamp(long ts)
void
setTrailerHttpFields(org.eclipse.jetty.http.HttpFields trailers)
void
setUserIdentityScope(UserIdentity.Scope scope)
javax.servlet.AsyncContext
startAsync()
javax.servlet.AsyncContext
startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)
boolean
takeNewContext()
java.lang.String
toString()
static javax.servlet.http.HttpServletRequest
unwrap(javax.servlet.ServletRequest servletRequest)
<T extends javax.servlet.http.HttpUpgradeHandler>
Tupgrade(java.lang.Class<T> handlerClass)
-
-
-
Field Detail
-
__MULTIPART_CONFIG_ELEMENT
public static final java.lang.String __MULTIPART_CONFIG_ELEMENT
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Request
public Request(HttpChannel channel, HttpInput input)
-
-
Method Detail
-
getBaseRequest
public static Request getBaseRequest(javax.servlet.ServletRequest request)
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 org.eclipse.jetty.http.HttpFields getHttpFields()
-
setHttpFields
public void setHttpFields(org.eclipse.jetty.http.HttpFields fields)
-
getTrailerFields
public java.util.Map<java.lang.String,java.lang.String> getTrailerFields()
- Specified by:
getTrailerFields
in interfacejavax.servlet.http.HttpServletRequest
-
setTrailerHttpFields
public void setTrailerHttpFields(org.eclipse.jetty.http.HttpFields trailers)
-
getTrailerHttpFields
public org.eclipse.jetty.http.HttpFields getTrailerHttpFields()
-
getHttpInput
public HttpInput getHttpInput()
-
isPush
public boolean isPush()
-
isPushSupported
public boolean isPushSupported()
-
newPushBuilder
public javax.servlet.http.PushBuilder newPushBuilder()
- Specified by:
newPushBuilder
in interfacejavax.servlet.http.HttpServletRequest
-
addEventListener
public void addEventListener(java.util.EventListener listener)
-
enterSession
public void enterSession(javax.servlet.http.HttpSession s)
Remember a session that this request has just entered.- Parameters:
s
- the session
-
extractFormParameters
public void extractFormParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> params)
-
getAsyncContext
public javax.servlet.AsyncContext getAsyncContext()
- Specified by:
getAsyncContext
in interfacejavax.servlet.ServletRequest
-
getHttpChannelState
public HttpChannelState getHttpChannelState()
-
getComplianceViolationListener
public org.eclipse.jetty.http.ComplianceViolation.Listener getComplianceViolationListener()
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
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 interfacejavax.servlet.ServletRequest
- See Also:
ServletRequest.getAttribute(java.lang.String)
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletRequest
-
getAttributes
public org.eclipse.jetty.util.Attributes getAttributes()
-
getAuthentication
public Authentication getAuthentication()
Get the authentication.- Returns:
- the authentication
-
getAuthType
public java.lang.String getAuthType()
- Specified by:
getAuthType
in interfacejavax.servlet.http.HttpServletRequest
-
getCharacterEncoding
public java.lang.String getCharacterEncoding()
- Specified by:
getCharacterEncoding
in interfacejavax.servlet.ServletRequest
-
getHttpChannel
public HttpChannel getHttpChannel()
- Returns:
- Returns the connection.
-
getContentLength
public int getContentLength()
- Specified by:
getContentLength
in interfacejavax.servlet.ServletRequest
-
getContentLengthLong
public long getContentLengthLong()
- Specified by:
getContentLengthLong
in interfacejavax.servlet.ServletRequest
-
getContentRead
public long getContentRead()
-
getContentType
public java.lang.String getContentType()
- Specified by:
getContentType
in interfacejavax.servlet.ServletRequest
-
getContext
public ContextHandler.Context getContext()
- Returns:
- The current
context
used for this request, ornull
ifsetContext(org.eclipse.jetty.server.handler.ContextHandler.Context, java.lang.String)
has not yet been called.
-
getErrorContext
public ContextHandler.Context getErrorContext()
- 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()
- Specified by:
getContextPath
in interfacejavax.servlet.http.HttpServletRequest
-
getPathInContext
public java.lang.String getPathInContext()
Get the path in the context. The path relative to the context path, analogous togetServletPath()
+getPathInfo()
. If no context is set, then the path in context is the full path.- Returns:
- The decoded part of the
getRequestURI()
path after anygetContextPath()
up to anygetQueryString()
, excluding path parameters. - See Also:
setContext(Context, String)
-
getCookies
public javax.servlet.http.Cookie[] getCookies()
- Specified by:
getCookies
in interfacejavax.servlet.http.HttpServletRequest
-
getDateHeader
public long getDateHeader(java.lang.String name)
- Specified by:
getDateHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getDispatcherType
public javax.servlet.DispatcherType getDispatcherType()
- Specified by:
getDispatcherType
in interfacejavax.servlet.ServletRequest
-
getHeader
public java.lang.String getHeader(java.lang.String name)
- Specified by:
getHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaderNames
public java.util.Enumeration<java.lang.String> getHeaderNames()
- Specified by:
getHeaderNames
in interfacejavax.servlet.http.HttpServletRequest
-
getHeaders
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
- Specified by:
getHeaders
in interfacejavax.servlet.http.HttpServletRequest
-
getInputState
public int getInputState()
- Returns:
- Returns the inputState.
-
getInputStream
public javax.servlet.ServletInputStream getInputStream() throws java.io.IOException
- Specified by:
getInputStream
in interfacejavax.servlet.ServletRequest
- Throws:
java.io.IOException
-
getIntHeader
public int getIntHeader(java.lang.String name)
- Specified by:
getIntHeader
in interfacejavax.servlet.http.HttpServletRequest
-
getLocale
public java.util.Locale getLocale()
- Specified by:
getLocale
in interfacejavax.servlet.ServletRequest
-
getLocales
public java.util.Enumeration<java.util.Locale> getLocales()
- Specified by:
getLocales
in interfacejavax.servlet.ServletRequest
-
getLocalAddr
public java.lang.String getLocalAddr()
- Specified by:
getLocalAddr
in interfacejavax.servlet.ServletRequest
-
getLocalName
public java.lang.String getLocalName()
- Specified by:
getLocalName
in interfacejavax.servlet.ServletRequest
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPort
in interfacejavax.servlet.ServletRequest
-
getMethod
public java.lang.String getMethod()
- Specified by:
getMethod
in interfacejavax.servlet.http.HttpServletRequest
-
getParameter
public java.lang.String getParameter(java.lang.String name)
- Specified by:
getParameter
in interfacejavax.servlet.ServletRequest
-
getParameterMap
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
- Specified by:
getParameterMap
in interfacejavax.servlet.ServletRequest
-
getParameterNames
public java.util.Enumeration<java.lang.String> getParameterNames()
- Specified by:
getParameterNames
in interfacejavax.servlet.ServletRequest
-
getParameterValues
public java.lang.String[] getParameterValues(java.lang.String name)
- Specified by:
getParameterValues
in interfacejavax.servlet.ServletRequest
-
getQueryParameters
public org.eclipse.jetty.util.MultiMap<java.lang.String> getQueryParameters()
-
setQueryParameters
public void setQueryParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> queryParameters)
-
setContentParameters
public void setContentParameters(org.eclipse.jetty.util.MultiMap<java.lang.String> contentParameters)
-
resetParameters
public void resetParameters()
-
getPathInfo
public java.lang.String getPathInfo()
- Specified by:
getPathInfo
in interfacejavax.servlet.http.HttpServletRequest
-
getPathTranslated
public java.lang.String getPathTranslated()
- Specified by:
getPathTranslated
in interfacejavax.servlet.http.HttpServletRequest
-
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocol
in interfacejavax.servlet.ServletRequest
-
getHttpVersion
public org.eclipse.jetty.http.HttpVersion getHttpVersion()
-
getQueryEncoding
public java.lang.String getQueryEncoding()
-
getQueryString
public java.lang.String getQueryString()
- Specified by:
getQueryString
in interfacejavax.servlet.http.HttpServletRequest
-
getReader
public java.io.BufferedReader getReader() throws java.io.IOException
- Specified by:
getReader
in interfacejavax.servlet.ServletRequest
- Throws:
java.io.IOException
-
getRealPath
@Deprecated(since="Servlet API 2.1") public java.lang.String getRealPath(java.lang.String path)
Deprecated.- Specified by:
getRealPath
in interfacejavax.servlet.ServletRequest
-
getRemoteInetSocketAddress
public java.net.InetSocketAddress getRemoteInetSocketAddress()
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()
- Specified by:
getRemoteAddr
in interfacejavax.servlet.ServletRequest
-
getRemoteHost
public java.lang.String getRemoteHost()
- Specified by:
getRemoteHost
in interfacejavax.servlet.ServletRequest
-
getRemotePort
public int getRemotePort()
- Specified by:
getRemotePort
in interfacejavax.servlet.ServletRequest
-
getRemoteUser
public java.lang.String getRemoteUser()
- Specified by:
getRemoteUser
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletRequest
-
getRequestedSessionId
public java.lang.String getRequestedSessionId()
- Specified by:
getRequestedSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURI
public java.lang.String getRequestURI()
- Specified by:
getRequestURI
in interfacejavax.servlet.http.HttpServletRequest
-
getRequestURL
public java.lang.StringBuffer getRequestURL()
- Specified by:
getRequestURL
in interfacejavax.servlet.http.HttpServletRequest
-
getResponse
public Response getResponse()
-
getRootURL
public java.lang.StringBuilder getRootURL()
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()
- Specified by:
getScheme
in interfacejavax.servlet.ServletRequest
-
getServerName
public java.lang.String getServerName()
- Specified by:
getServerName
in interfacejavax.servlet.ServletRequest
-
getServerPort
public int getServerPort()
- Specified by:
getServerPort
in interfacejavax.servlet.ServletRequest
-
getServletContext
public javax.servlet.ServletContext getServletContext()
- Specified by:
getServletContext
in interfacejavax.servlet.ServletRequest
-
getServletName
public java.lang.String getServletName()
-
getServletPath
public java.lang.String getServletPath()
- Specified by:
getServletPath
in interfacejavax.servlet.http.HttpServletRequest
-
getServletResponse
public javax.servlet.ServletResponse getServletResponse()
-
changeSessionId
public java.lang.String changeSessionId()
- Specified by:
changeSessionId
in interfacejavax.servlet.http.HttpServletRequest
-
onCompleted
public void onCompleted()
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()
Called when a response is about to be committed, ie sent back to the client
-
getSession
public javax.servlet.http.HttpSession getSession(SessionHandler sessionHandler)
Find a session that this request has already entered for the given SessionHandler- Parameters:
sessionHandler
- the SessionHandler (ie context) to check- Returns:
- the session for the passed session handler or null
-
getSession
public javax.servlet.http.HttpSession getSession()
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
getSession
public javax.servlet.http.HttpSession getSession(boolean create)
- Specified by:
getSession
in interfacejavax.servlet.http.HttpServletRequest
-
getSessionHandler
public SessionHandler getSessionHandler()
- Returns:
- Returns the sessionManager.
-
getTimeStamp
public long getTimeStamp()
Get Request TimeStamp- Returns:
- The time that the request was received.
-
getHttpURI
public org.eclipse.jetty.http.HttpURI getHttpURI()
-
setHttpURI
public void setHttpURI(org.eclipse.jetty.http.HttpURI uri)
-
getOriginalURI
public java.lang.String getOriginalURI()
- Returns:
- Returns the original uri passed in metadata before customization/rewrite
-
getUserIdentity
public UserIdentity getUserIdentity()
-
getResolvedUserIdentity
public UserIdentity getResolvedUserIdentity()
- Returns:
- The resolved user Identity, which may be null if the
Authentication
is notAuthentication.User
(eg.Authentication.Deferred
).
-
getUserIdentityScope
public UserIdentity.Scope getUserIdentityScope()
-
getUserPrincipal
public java.security.Principal getUserPrincipal()
- Specified by:
getUserPrincipal
in interfacejavax.servlet.http.HttpServletRequest
-
isHandled
public boolean isHandled()
-
isAsyncStarted
public boolean isAsyncStarted()
- Specified by:
isAsyncStarted
in interfacejavax.servlet.ServletRequest
-
isAsyncSupported
public boolean isAsyncSupported()
- Specified by:
isAsyncSupported
in interfacejavax.servlet.ServletRequest
-
isRequestedSessionIdFromCookie
public boolean isRequestedSessionIdFromCookie()
- Specified by:
isRequestedSessionIdFromCookie
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromUrl
@Deprecated(since="Servlet API 2.1") public boolean isRequestedSessionIdFromUrl()
Deprecated.- Specified by:
isRequestedSessionIdFromUrl
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdFromURL
public boolean isRequestedSessionIdFromURL()
- Specified by:
isRequestedSessionIdFromURL
in interfacejavax.servlet.http.HttpServletRequest
-
isRequestedSessionIdValid
public boolean isRequestedSessionIdValid()
- Specified by:
isRequestedSessionIdValid
in interfacejavax.servlet.http.HttpServletRequest
-
isSecure
public boolean isSecure()
- Specified by:
isSecure
in interfacejavax.servlet.ServletRequest
-
setSecure
public void setSecure(boolean secure)
-
isUserInRole
public boolean isUserInRole(java.lang.String role)
- Specified by:
isUserInRole
in interfacejavax.servlet.http.HttpServletRequest
-
setMetaData
public void setMetaData(org.eclipse.jetty.http.MetaData.Request request)
- Parameters:
request
- the Request metadata
-
getMetaData
public org.eclipse.jetty.http.MetaData.Request getMetaData()
-
hasMetaData
public boolean hasMetaData()
-
recycle
protected void recycle()
-
removeAttribute
public void removeAttribute(java.lang.String name)
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletRequest
-
removeEventListener
public void removeEventListener(java.util.EventListener listener)
-
setAsyncSupported
public void setAsyncSupported(boolean supported, java.lang.Object source)
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)
Set a request attribute. if the attribute name is "org.eclipse.jetty.server.server.Request.queryEncoding" then the value is also passed in a call tosetQueryEncoding(java.lang.String)
.- Specified by:
setAttribute
in interfacejavax.servlet.ServletRequest
- See Also:
ServletRequest.setAttribute(java.lang.String, java.lang.Object)
-
setAttributes
public void setAttributes(org.eclipse.jetty.util.Attributes attributes)
Set the attributes for the request.- Parameters:
attributes
- The attributes, which must be aAttributes.Wrapper
for whichAttributes.unwrap(Attributes)
will return the originalServletAttributes
.
-
setAsyncAttributes
public void setAsyncAttributes()
-
setAuthentication
public void setAuthentication(Authentication authentication)
Set the authentication.- Parameters:
authentication
- the authentication to set
-
setCharacterEncoding
public void setCharacterEncoding(java.lang.String encoding) throws java.io.UnsupportedEncodingException
- Specified by:
setCharacterEncoding
in interfacejavax.servlet.ServletRequest
- Throws:
java.io.UnsupportedEncodingException
-
setCharacterEncodingUnchecked
public void setCharacterEncodingUnchecked(java.lang.String encoding)
-
setContentType
public void setContentType(java.lang.String contentType)
-
setContext
public void setContext(ContextHandler.Context context, java.lang.String pathInContext)
Set request context and path in the context.- Parameters:
context
- context objectpathInContext
- the part of the URI path that is withing the context. For servlets, this is equal to servletPath + pathInfo
-
takeNewContext
public boolean takeNewContext()
- Returns:
- True if this is the first call of
takeNewContext()
since the lastsetContext(org.eclipse.jetty.server.handler.ContextHandler.Context, String)
call.
-
setCookies
public void setCookies(javax.servlet.http.Cookie[] cookies)
- Parameters:
cookies
- The cookies to set.
-
setDispatcherType
public void setDispatcherType(javax.servlet.DispatcherType type)
-
setHandled
public void setHandled(boolean h)
-
setMethod
public void setMethod(java.lang.String method)
- Parameters:
method
- The method to set.
-
isHead
public boolean isHead()
-
setQueryEncoding
public void setQueryEncoding(java.lang.String queryEncoding)
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
-
setRemoteAddr
public void setRemoteAddr(java.net.InetSocketAddress addr)
- Parameters:
addr
- The address to set.
-
setRequestedSessionId
public void setRequestedSessionId(java.lang.String requestedSessionId)
- Parameters:
requestedSessionId
- The requestedSessionId to set.
-
setRequestedSessionIdFromCookie
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdCookie)
- Parameters:
requestedSessionIdCookie
- The requestedSessionIdCookie to set.
-
setSession
public void setSession(javax.servlet.http.HttpSession session)
- Parameters:
session
- The session to set.
-
setSessionHandler
public void setSessionHandler(SessionHandler sessionHandler)
- Parameters:
sessionHandler
- The SessionHandler to set.
-
setTimeStamp
public void setTimeStamp(long ts)
-
setUserIdentityScope
public void setUserIdentityScope(UserIdentity.Scope scope)
-
startAsync
public javax.servlet.AsyncContext startAsync() throws java.lang.IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
java.lang.IllegalStateException
-
startAsync
public javax.servlet.AsyncContext startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws java.lang.IllegalStateException
- Specified by:
startAsync
in interfacejavax.servlet.ServletRequest
- Throws:
java.lang.IllegalStateException
-
unwrap
public static javax.servlet.http.HttpServletRequest unwrap(javax.servlet.ServletRequest servletRequest)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
authenticate
public boolean authenticate(javax.servlet.http.HttpServletResponse response) throws java.io.IOException, javax.servlet.ServletException
- Specified by:
authenticate
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
java.io.IOException
javax.servlet.ServletException
-
getPart
public javax.servlet.http.Part getPart(java.lang.String name) throws java.io.IOException, javax.servlet.ServletException
- Specified by:
getPart
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
java.io.IOException
javax.servlet.ServletException
-
getParts
public java.util.Collection<javax.servlet.http.Part> getParts() throws java.io.IOException, javax.servlet.ServletException
- Specified by:
getParts
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
java.io.IOException
javax.servlet.ServletException
-
login
public void login(java.lang.String username, java.lang.String password) throws javax.servlet.ServletException
- Specified by:
login
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
javax.servlet.ServletException
-
logout
public void logout() throws javax.servlet.ServletException
- Specified by:
logout
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
javax.servlet.ServletException
-
mergeQueryParameters
public void mergeQueryParameters(java.lang.String oldQuery, java.lang.String newQuery)
-
upgrade
public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade(java.lang.Class<T> handlerClass) throws java.io.IOException, javax.servlet.ServletException
- Specified by:
upgrade
in interfacejavax.servlet.http.HttpServletRequest
- Throws:
java.io.IOException
javax.servlet.ServletException
-
setServletPathMapping
public void setServletPathMapping(ServletPathMapping servletPathMapping)
Set the servletPathMapping, the servletPath and the pathInfo.- Parameters:
servletPathMapping
- The mapping used to return fromgetHttpServletMapping()
-
getServletPathMapping
public ServletPathMapping getServletPathMapping()
- Returns:
- The mapping for the current target servlet, regardless of dispatch type.
-
getHttpServletMapping
public javax.servlet.http.HttpServletMapping getHttpServletMapping()
- Specified by:
getHttpServletMapping
in interfacejavax.servlet.http.HttpServletRequest
-
-