Top Description Fields Constructors Methods
org.eclipse.jetty.ee10.servlet

public Class ServletContextRequest

extends ContextRequest
implements ServletRequestInfo, ServeAs
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.server.Request.ServeAs, org.eclipse.jetty.server.Request, org.eclipse.jetty.io.Content.Source, org.eclipse.jetty.util.Attributes, org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo
Imports
java.nio.charset.Charset, java.util.ArrayList, .Collections, .EventListener, .List, .Set, jakarta.servlet.AsyncListener, .ServletRequest, .ServletRequestAttributeListener, .ServletRequestWrapper, jakarta.servlet.http.HttpServletResponse, org.eclipse.jetty.http.HttpCookie, .HttpFields, .HttpMethod, .HttpURI, .UriCompliance, org.eclipse.jetty.http.pathmap.MatchedResource, org.eclipse.jetty.io.EndPoint, org.eclipse.jetty.server.FormFields, .Request, .Response, .Session, org.eclipse.jetty.server.handler.ContextHandler, .ContextRequest, org.eclipse.jetty.session.AbstractSessionManager, .ManagedSession, .SessionManager, org.eclipse.jetty.util.Attributes, .Fields, .URIUtil
A core request wrapper that carries the servlet related request state, which may be used directly by the associated ServletApiRequest. Non-servlet related state, is used indirectly via ServletChannel#getRequest() which may be a wrapper of this request.

This class is single use only.

Field Summary

Modifier and TypeField and Description
private final Attributes
_attributes

private final String
_decodedPathInContext

private final HttpInput
_httpInput

private ManagedSession
_managedSession

private final MatchedResource<ServletHandler.MappedServlet>
_matchedResource

private Charset
_queryEncoding

private List<ServletRequestAttributeListener>
_requestAttributeListeners

pack-priv AbstractSessionManager.RequestedSession
_requestedSession

private final ServletContextResponse
_response

private final ServletApiRequest
_servletApiRequest

private final ServletChannel
_servletChannel

private final SessionManager
_sessionManager

private HttpFields
_trailers

private static final Set<String>
ATTRIBUTES

pack-priv static final Fields
BAD_PARAMS

pack-priv static final int
INPUT_NONE

pack-priv static final int
INPUT_READER

pack-priv static final int
INPUT_STREAM

public static final String
MULTIPART_CONFIG_ELEMENT

pack-priv static final Fields
NO_PARAMS

public static final String
PEER_CERTIFICATES

public static final String
SSL_CIPHER_SUITE

public static final String
SSL_KEY_SIZE

public static final String
SSL_SESSION_ID

Constructor Summary

AccessConstructor and Description
protected
ServletContextRequest(ServletContextHandler.ServletContextApi servletContextApi, ServletChannel servletChannel, Request request, Response response, String decodedPathInContext, MatchedResource<ServletHandler.MappedServlet> matchedResource, SessionManager sessionManager)

Method Summary

Modifier and TypeMethod and Description
public void
addEventListener(EventListener listener)

public void
errorClose()

public Object
getAttribute(String
the attribute to get
name)

Overrides org.eclipse.jetty.server.Request.Wrapper.getAttribute.

Implements org.eclipse.jetty.util.Attributes.getAttribute.

Get an attribute

public Set<String>
getAttributeNameSet()

Overrides org.eclipse.jetty.server.Request.Wrapper.getAttributeNameSet.

Implements org.eclipse.jetty.util.Attributes.getAttributeNameSet.

Get the immutable set of attribute names.

public String
getDecodedPathInContext()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getDecodedPathInContext.

public ServletContextHandler.ServletScopedContext
getErrorContext()

Returns: The current context used for this error handling for this request.

public HttpInput
getHttpInput()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getHttpInput.

public HttpOutput
getHttpOutput()

public HttpServletResponse
getHttpServletResponse()

public ManagedSession
getManagedSession()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getManagedSession.

public MatchedResource<ServletHandler.MappedServlet>
getMatchedResource()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getMatchedResource.

public Charset
getQueryEncoding()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getQueryEncoding.

public List<ServletRequestAttributeListener>
getRequestAttributeListeners()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getRequestAttributeListeners.

public AbstractSessionManager.RequestedSession
getRequestedSession()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getRequestedSession.

public ServletApiRequest
getServletApiRequest()

public ServletChannel
getServletChannel()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletChannel.

public ServletContextHandler.ServletScopedContext
getServletContext()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletContext.

public ServletContextHandler
getServletContextHandler()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletContextHandler.

public static ServletContextRequest
getServletContextRequest(ServletRequest request)

public ServletContextResponse
getServletContextResponse()

public String
getServletName()

public ServletChannelState
getServletRequestState()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletRequestState.

public Session
getSession(boolean
True if the session should be created for the request.
create)

Overrides org.eclipse.jetty.server.Request.Wrapper.getSession.

Implements org.eclipse.jetty.server.Request.getSession.

Get a Session associated with the request.

public SessionManager
getSessionManager()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getSessionManager.

public ServletChannelState
getState()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getState.

public HttpFields
getTrailers()

Overrides org.eclipse.jetty.server.Request.Wrapper.getTrailers.

Implements org.eclipse.jetty.server.Request.getTrailers.

public boolean
isHead()

pack-priv static boolean

Returns:

true if the fields reference is equal to NO_PARAMS, otherwise false
isNoParams(Fields
The parameters to compare to NO_PARAMS
fields)

Compares fields to NO_PARAMS by Reference

protected ServletApiRequest
newServletApiRequest()

protected ServletContextResponse
newServletContextResponse(Response response)

public Object
removeAttribute(String
the attribute to remove
name)

Overrides org.eclipse.jetty.server.Request.Wrapper.removeAttribute.

Implements org.eclipse.jetty.util.Attributes.removeAttribute.

Remove an attribute

public void
removeEventListener(EventListener listener)

public Object
setAttribute(String
the attribute to set
name, Object
the value to set. A null value is equivalent to removing the attribute.
value)

Overrides org.eclipse.jetty.server.Request.Wrapper.setAttribute.

Implements org.eclipse.jetty.util.Attributes.setAttribute.

Set an attribute

public void
setManagedSession(ManagedSession managedSession)

public void
setQueryEncoding(String
the URI query character encoding
queryEncoding)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.setQueryEncoding.

Set the character encoding used for the query string.

public void
setRequestedSession(AbstractSessionManager.RequestedSession requestedSession)

pack-priv void
setTrailers(HttpFields trailers)

public Request
wrap(Request
the original request.
request, HttpURI
the uri of the new target.
uri)

Implements org.eclipse.jetty.server.Request.ServeAs.wrap.

Wraps a request but changes the uri so that it can be served to a different target.

Inherited from org.eclipse.jetty.server.handler.ContextRequest:
addFailureListeneraddIdleTimeoutListenerdemandgetContext

Field Detail

_attributesback to summary
private final Attributes _attributes
_decodedPathInContextback to summary
private final String _decodedPathInContext
_httpInputback to summary
private final HttpInput _httpInput
_managedSessionback to summary
private ManagedSession _managedSession
_matchedResourceback to summary
private final MatchedResource<ServletHandler.MappedServlet> _matchedResource
_queryEncodingback to summary
private Charset _queryEncoding
_requestAttributeListenersback to summary
private List<ServletRequestAttributeListener> _requestAttributeListeners
_requestedSessionback to summary
pack-priv AbstractSessionManager.RequestedSession _requestedSession
_responseback to summary
private final ServletContextResponse _response
_servletApiRequestback to summary
private final ServletApiRequest _servletApiRequest
_servletChannelback to summary
private final ServletChannel _servletChannel
_sessionManagerback to summary
private final SessionManager _sessionManager
_trailersback to summary
private HttpFields _trailers
ATTRIBUTESback to summary
private static final Set<String> ATTRIBUTES
BAD_PARAMSback to summary
pack-priv static final Fields BAD_PARAMS
INPUT_NONEback to summary
pack-priv static final int INPUT_NONE
INPUT_READERback to summary
pack-priv static final int INPUT_READER
INPUT_STREAMback to summary
pack-priv static final int INPUT_STREAM
MULTIPART_CONFIG_ELEMENTback to summary
public static final String MULTIPART_CONFIG_ELEMENT
NO_PARAMSback to summary
pack-priv static final Fields NO_PARAMS
PEER_CERTIFICATESback to summary
public static final String PEER_CERTIFICATES
SSL_CIPHER_SUITEback to summary
public static final String SSL_CIPHER_SUITE
SSL_KEY_SIZEback to summary
public static final String SSL_KEY_SIZE
SSL_SESSION_IDback to summary
public static final String SSL_SESSION_ID

Constructor Detail

ServletContextRequestback to summary
protected ServletContextRequest(ServletContextHandler.ServletContextApi servletContextApi, ServletChannel servletChannel, Request request, Response response, String decodedPathInContext, MatchedResource<ServletHandler.MappedServlet> matchedResource, SessionManager sessionManager)

Method Detail

addEventListenerback to summary
public void addEventListener(EventListener listener)
errorCloseback to summary
public void errorClose()
getAttributeback to summary
public Object getAttribute(String name)

Overrides org.eclipse.jetty.server.Request.Wrapper.getAttribute.

Implements org.eclipse.jetty.util.Attributes.getAttribute.

Doc from org.eclipse.jetty.util.Attributes.getAttribute.

Get an attribute

Parameters
name:String

the attribute to get

Returns:Object

the value of the attribute

Annotations
@Override
getAttributeNameSetback to summary
public Set<String> getAttributeNameSet()

Overrides org.eclipse.jetty.server.Request.Wrapper.getAttributeNameSet.

Implements org.eclipse.jetty.util.Attributes.getAttributeNameSet.

Doc from org.eclipse.jetty.util.Attributes.getAttributeNameSet.

Get the immutable set of attribute names.

Returns:Set<String>

Set of attribute names

Annotations
@Override
getDecodedPathInContextback to summary
public String getDecodedPathInContext()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getDecodedPathInContext.

Annotations
@Override
getErrorContextback to summary
public ServletContextHandler.ServletScopedContext getErrorContext()
Returns:ServletContextHandler.ServletScopedContext

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

getHttpInputback to summary
public HttpInput getHttpInput()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getHttpInput.

Annotations
@Override
getHttpOutputback to summary
public HttpOutput getHttpOutput()
getHttpServletResponseback to summary
public HttpServletResponse getHttpServletResponse()
getManagedSessionback to summary
public ManagedSession getManagedSession()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getManagedSession.

Annotations
@Override
getMatchedResourceback to summary
public MatchedResource<ServletHandler.MappedServlet> getMatchedResource()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getMatchedResource.

Annotations
@Override
getQueryEncodingback to summary
public Charset getQueryEncoding()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getQueryEncoding.

Annotations
@Override
getRequestAttributeListenersback to summary
public List<ServletRequestAttributeListener> getRequestAttributeListeners()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getRequestAttributeListeners.

Annotations
@Override
getRequestedSessionback to summary
public AbstractSessionManager.RequestedSession getRequestedSession()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getRequestedSession.

Annotations
@Override
getServletApiRequestback to summary
public ServletApiRequest getServletApiRequest()
getServletChannelback to summary
public ServletChannel getServletChannel()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletChannel.

Annotations
@Override
getServletContextback to summary
public ServletContextHandler.ServletScopedContext getServletContext()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletContext.

Annotations
@Override
getServletContextHandlerback to summary
public ServletContextHandler getServletContextHandler()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletContextHandler.

Annotations
@Override
getServletContextRequestback to summary
public static ServletContextRequest getServletContextRequest(ServletRequest request)
getServletContextResponseback to summary
public ServletContextResponse getServletContextResponse()
getServletNameback to summary
public String getServletName()
getServletRequestStateback to summary
public ServletChannelState getServletRequestState()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getServletRequestState.

Annotations
@Override
getSessionback to summary
public Session getSession(boolean create)

Overrides org.eclipse.jetty.server.Request.Wrapper.getSession.

Implements org.eclipse.jetty.server.Request.getSession.

Doc from org.eclipse.jetty.server.Request.getSession.

Get a Session associated with the request. Sessions may not be supported by a given configuration, in which case null will be returned.

Parameters
create:boolean

True if the session should be created for the request.

Returns:Session

The session associated with the request or null.

Annotations
@Override
getSessionManagerback to summary
public SessionManager getSessionManager()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getSessionManager.

Annotations
@Override
getStateback to summary
public ServletChannelState getState()

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.getState.

Annotations
@Override
getTrailersback to summary
public HttpFields getTrailers()

Overrides org.eclipse.jetty.server.Request.Wrapper.getTrailers.

Implements org.eclipse.jetty.server.Request.getTrailers.

Returns:HttpFields

Doc from org.eclipse.jetty.server.Request.getTrailers.

the HTTP trailers of this Request, or null if they are not present

Annotations
@Override
isHeadback to summary
public boolean isHead()
isNoParamsback to summary
pack-priv static boolean isNoParams(Fields fields)

Compares fields to NO_PARAMS by Reference

Parameters
fields:Fields

The parameters to compare to NO_PARAMS

Returns:boolean

true if the fields reference is equal to NO_PARAMS, otherwise false

newServletApiRequestback to summary
protected ServletApiRequest newServletApiRequest()
newServletContextResponseback to summary
protected ServletContextResponse newServletContextResponse(Response response)
removeAttributeback to summary
public Object removeAttribute(String name)

Overrides org.eclipse.jetty.server.Request.Wrapper.removeAttribute.

Implements org.eclipse.jetty.util.Attributes.removeAttribute.

Doc from org.eclipse.jetty.util.Attributes.removeAttribute.

Remove an attribute

Parameters
name:String

the attribute to remove

Returns:Object

the value of the attribute if removed, else null

Annotations
@Override
removeEventListenerback to summary
public void removeEventListener(EventListener listener)
setAttributeback to summary
public Object setAttribute(String name, Object value)

Overrides org.eclipse.jetty.server.Request.Wrapper.setAttribute.

Implements org.eclipse.jetty.util.Attributes.setAttribute.

Doc from org.eclipse.jetty.util.Attributes.setAttribute.

Set an attribute

Parameters
name:String

the attribute to set

value:Object

the value to set. A null value is equivalent to removing the attribute.

Returns:Object

the previous value of the attribute if set, else null

Annotations
@Override
setManagedSessionback to summary
public void setManagedSession(ManagedSession managedSession)
setQueryEncodingback to summary
public void setQueryEncoding(String queryEncoding)

Implements org.eclipse.jetty.ee10.servlet.ServletContextHandler.ServletRequestInfo.setQueryEncoding.

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:String

the URI query character encoding

Annotations
@Override
setRequestedSessionback to summary
public void setRequestedSession(AbstractSessionManager.RequestedSession requestedSession)
setTrailersback to summary
pack-priv void setTrailers(HttpFields trailers)
wrapback to summary
public Request wrap(Request request, HttpURI uri)

Implements org.eclipse.jetty.server.Request.ServeAs.wrap.

Doc from org.eclipse.jetty.server.Request.ServeAs.wrap.

Wraps a request but changes the uri so that it can be served to a different target.

Parameters
request:Request

the original request.

uri:HttpURI

the uri of the new target.

Returns:Request

the request wrapped to the new target.

Annotations
@Override