Class ServletContextRequest

java.lang.Object

org.eclipse.jetty.server.Request.Wrapper

org.eclipse.jetty.server.handler.ContextRequest

org.eclipse.jetty.ee11.servlet.ServletContextRequest

All Implemented Interfaces:

ServletContextHandler.ServletRequestInfo, Content.Source, Request, Request.ServeAs, Attributes, Invocable

public class ServletContextRequest
extends ContextRequest
implements ServletContextHandler.ServletRequestInfo, Request.ServeAs

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.

Nested Class Summary

Nested classes/interfaces inherited from interface Attributes

Attributes.Layer, Attributes.Lazy, Attributes.Mapped, Attributes.Synthetic

Nested classes/interfaces inherited from interface Content.Source

Content.Source.Factory

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Nested classes/interfaces inherited from interface Request

Request.AttributesWrapper, Request.AuthenticationState, Request.Handler, Request.ServeAs, Request.Wrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTIPART_CONFIG_ELEMENT
static final String	PEER_CERTIFICATES
static final String	SSL_CIPHER_SUITE
static final String	SSL_KEY_SIZE
static final String	SSL_SESSION_ID

Fields inherited from interface Attributes

NULL

Fields inherited from interface Invocable

__nonBlocking, NOOP

Fields inherited from interface Request

COOKIE_ATTRIBUTE, DEFAULT_LOCALES, LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addEventListener(EventListener listener)
void	errorClose()
Object	getAttribute(String name)	Get an attribute by name.
Set<String>	getAttributeNameSet()	Get the immutable set of attribute names.
String	getDecodedPathInContext()
ServletContextHandler.ServletScopedContext	getErrorContext()
HttpInput	getHttpInput()
HttpOutput	getHttpOutput()
jakarta.servlet.http.HttpServletResponse	getHttpServletResponse()
ManagedSession	getManagedSession()
MatchedResource<ServletHandler.MappedServlet>	getMatchedResource()
Charset	getQueryEncoding()
List<jakarta.servlet.ServletRequestAttributeListener>	getRequestAttributeListeners()
AbstractSessionManager.RequestedSession	getRequestedSession()
ServletApiRequest	getServletApiRequest()
ServletChannel	getServletChannel()
ServletContextHandler.ServletScopedContext	getServletContext()
ServletContextHandler	getServletContextHandler()
static ServletContextRequest	getServletContextRequest(jakarta.servlet.ServletRequest request)
ServletContextResponse	getServletContextResponse()
String	getServletName()
ServletChannelState	getServletRequestState()
Session	getSession(boolean create)	Get a Session associated with the request.
SessionManager	getSessionManager()
ServletChannelState	getState()
HttpFields	getTrailers()
boolean	isHead()
protected ServletApiRequest	newServletApiRequest()
protected ServletContextResponse	newServletContextResponse(Response response)
Object	removeAttribute(String name)	Remove an attribute
void	removeEventListener(EventListener listener)
Object	setAttribute(String name, Object value)	Set an attribute
void	setManagedSession(ManagedSession managedSession)
void	setQueryEncoding(String queryEncoding)	Set the character encoding used for the query string.
void	setRequestedSession(AbstractSessionManager.RequestedSession requestedSession)
Request	wrap(Request request, HttpURI uri)	Wraps a request but changes the uri so that it can be served to a different target.

Methods inherited from class ContextRequest

addFailureListener, addIdleTimeoutListener, demand, getContext

Methods inherited from class Request.Wrapper

addHttpStreamWrapper, asAttributeMap, clearAttributes, consumeAvailable, fail, getBeginNanoTime, getComponents, getConnectionMetaData, getHeaders, getHeadersNanoTime, getHttpURI, getId, getLength, getMethod, getTunnelSupport, getWrapped, isSecure, push, read, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Attributes

asAttributeMap, clearAttributes, equals, hashCode

Methods inherited from interface Content.Source

fail, fail, getLength, rewind

Methods inherited from interface Invocable

getInvocationType

Methods inherited from interface Request

addFailureListener, addHttpStreamWrapper, addIdleTimeoutListener, consumeAvailable, demand, getBeginNanoTime, getComponents, getConnectionMetaData, getContext, getHeaders, getHeadersNanoTime, getHttpURI, getId, getMethod, getTunnelSupport, isSecure, push, read

Methods inherited from interface ServletContextHandler.ServletRequestInfo

getRequest

Field Details

MULTIPART_CONFIG_ELEMENT

public static final String MULTIPART_CONFIG_ELEMENT

See Also:

• Constant Field Values

SSL_CIPHER_SUITE

public static final String SSL_CIPHER_SUITE

See Also:

• Constant Field Values

SSL_KEY_SIZE

public static final String SSL_KEY_SIZE

See Also:

• Constant Field Values

SSL_SESSION_ID

public static final String SSL_SESSION_ID

See Also:

• Constant Field Values

PEER_CERTIFICATES

public static final String PEER_CERTIFICATES

See Also:

• Constant Field Values

Constructor Details

ServletContextRequest

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

Method Details

getServletContextRequest

public static ServletContextRequest getServletContextRequest(jakarta.servlet.ServletRequest request)

wrap

public Request wrap(Request request,
 HttpURI uri)

Description copied from interface: Request.ServeAs

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

Specified by:

wrap in interface Request.ServeAs

Parameters:

request - the original request.

uri - the uri of the new target.

Returns:

the request wrapped to the new target.

newServletApiRequest

protected ServletApiRequest newServletApiRequest()

newServletContextResponse

protected ServletContextResponse newServletContextResponse(Response response)

getServletContextHandler

public ServletContextHandler getServletContextHandler()

Specified by:

getServletContextHandler in interface ServletContextHandler.ServletRequestInfo

getDecodedPathInContext

public String getDecodedPathInContext()

Specified by:

getDecodedPathInContext in interface ServletContextHandler.ServletRequestInfo

getMatchedResource

public MatchedResource<ServletHandler.MappedServlet> getMatchedResource()

Specified by:

getMatchedResource in interface ServletContextHandler.ServletRequestInfo

getTrailers

public HttpFields getTrailers()

Specified by:

getTrailers in interface Request

Overrides:

getTrailers in class Request.Wrapper

Returns:

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

getState

public ServletChannelState getState()

Specified by:

getState in interface ServletContextHandler.ServletRequestInfo

getServletContextResponse

public ServletContextResponse getServletContextResponse()

getServletContext

public ServletContextHandler.ServletScopedContext getServletContext()

Specified by:

getServletContext in interface ServletContextHandler.ServletRequestInfo

getHttpInput

public HttpInput getHttpInput()

Specified by:

getHttpInput in interface ServletContextHandler.ServletRequestInfo

getHttpOutput

public HttpOutput getHttpOutput()

errorClose

public void errorClose()

isHead

public boolean isHead()

setQueryEncoding

public void setQueryEncoding(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.

Specified by:

setQueryEncoding in interface ServletContextHandler.ServletRequestInfo

Parameters:

queryEncoding - the URI query character encoding

getQueryEncoding

public Charset getQueryEncoding()

Specified by:

getQueryEncoding in interface ServletContextHandler.ServletRequestInfo

getAttribute

public Object getAttribute(String name)

Description copied from interface: Attributes

Get an attribute by name. Some attributes may be "hidden" attributes, in that they are only found by an explicit call to getAttribute(String) and they do not otherwise appear in Attributes.getAttributeNameSet() or Attributes.asAttributeMap().

Specified by:

getAttribute in interface Attributes

Overrides:

getAttribute in class Request.Wrapper

Parameters:

name - the attribute to get

Returns:

the value of the attribute, or null if no such attribute exists

removeAttribute

public Object removeAttribute(String name)

Description copied from interface: Attributes

Remove an attribute

Specified by:

removeAttribute in interface Attributes

Overrides:

removeAttribute in class Request.Wrapper

Parameters:

name - the attribute to remove

Returns:

the value of the attribute if removed, else null

setAttribute

public Object setAttribute(String name,
 Object value)

Description copied from interface: Attributes

Set an attribute

Specified by:

setAttribute in interface Attributes

Overrides:

setAttribute in class Request.Wrapper

Parameters:

name - the attribute to set

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

Returns:

the previous value of the attribute if set, else null

getAttributeNameSet

public Set<String> getAttributeNameSet()

Description copied from interface: Attributes

Get the immutable set of attribute names.

Specified by:

getAttributeNameSet in interface Attributes

Overrides:

getAttributeNameSet in class Request.Wrapper

Returns:

Set of attribute names, or an empty set if there are no attributes.

getErrorContext

public ServletContextHandler.ServletScopedContext 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

getServletRequestState

public ServletChannelState getServletRequestState()

Specified by:

getServletRequestState in interface ServletContextHandler.ServletRequestInfo

getServletChannel

public ServletChannel getServletChannel()

Specified by:

getServletChannel in interface ServletContextHandler.ServletRequestInfo

getServletApiRequest

public ServletApiRequest getServletApiRequest()

getHttpServletResponse

public jakarta.servlet.http.HttpServletResponse getHttpServletResponse()

getServletName

public String getServletName()

getRequestAttributeListeners

public List<jakarta.servlet.ServletRequestAttributeListener> getRequestAttributeListeners()

Specified by:

getRequestAttributeListeners in interface ServletContextHandler.ServletRequestInfo

addEventListener

public void addEventListener(EventListener listener)

removeEventListener

public void removeEventListener(EventListener listener)

getManagedSession

public ManagedSession getManagedSession()

Specified by:

getManagedSession in interface ServletContextHandler.ServletRequestInfo

setManagedSession

public void setManagedSession(ManagedSession managedSession)

getSessionManager

public SessionManager getSessionManager()

Specified by:

getSessionManager in interface ServletContextHandler.ServletRequestInfo

setRequestedSession

public void setRequestedSession(AbstractSessionManager.RequestedSession requestedSession)

getRequestedSession

public AbstractSessionManager.RequestedSession getRequestedSession()

Specified by:

getRequestedSession in interface ServletContextHandler.ServletRequestInfo

getSession

public Session getSession(boolean create)

Description copied from interface: Request

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

Specified by:

getSession in interface Request

Overrides:

getSession in class Request.Wrapper

Parameters:

create - True if the session should be created for the request.

Returns:

The session associated with the request or null.