Package io.undertow.servlet.handlers

Class ServletRequestContext

java.lang.Object

io.undertow.servlet.handlers.ServletRequestContext

public class ServletRequestContext
extends java.lang.Object

All the information that servlet needs to attach to the exchange.

This is all stored under this class, rather than using individual attachments, as this approach has significant performance advantages.

The ServletInitialHandler also pushed this information to the CURRENT thread local, which allows it to be access even if the request or response have been wrapped with non-compliant wrapper classes.

Author:

Stuart Douglas

Field Summary

Fields

Modifier and Type	Field	Description
static io.undertow.util.AttachmentKey<ServletRequestContext>	ATTACHMENT_KEY

Constructor Summary

Constructors

Constructor	Description
ServletRequestContext(Deployment deployment, HttpServletRequestImpl originalRequest, HttpServletResponseImpl originalResponse, ServletPathMatch originalServletPathMatch)

Method Summary

Modifier and Type	Method	Description
static void	clearCurrentServletAttachments()
static ServletRequestContext	current()	Gets the current threads ServletRequestContext if set, otherwise null.
boolean	displayStackTraces()
ServletChain	getCurrentServlet()
ServletContextImpl	getCurrentServletContext()
Deployment	getDeployment()
jakarta.servlet.DispatcherType	getDispatcherType()
int	getErrorCode()
java.lang.String	getErrorMessage()
io.undertow.server.HttpServerExchange	getExchange()
HttpServletRequestImpl	getOriginalRequest()
HttpServletResponseImpl	getOriginalResponse()
ServletPathMatch	getOriginalServletPathMatch()
java.lang.String	getOverridenSessionId()
java.util.List<SingleConstraintMatch>	getRequiredConstrains()
ServletPathMatch	getServletPathMatch()
jakarta.servlet.ServletRequest	getServletRequest()
jakarta.servlet.ServletResponse	getServletResponse()
HttpSessionImpl	getSession()
TransportGuaranteeType	getTransportGuarenteeType()
boolean	isAsyncSupported()
boolean	isRunningInsideHandler()
static ServletRequestContext	requireCurrent()	Gets the ServletRequestContext assigned to the current thread.
void	setAsyncSupported(boolean asyncSupported)
static void	setCurrentRequestContext(ServletRequestContext servletRequestContext)
void	setCurrentServlet(ServletChain currentServlet)
void	setCurrentServletContext(ServletContextImpl currentServletContext)
void	setDispatcherType(jakarta.servlet.DispatcherType dispatcherType)
void	setError(int sc, java.lang.String msg)
void	setOverridenSessionId(java.lang.String overridenSessionId)
void	setRequiredConstrains(java.util.List<SingleConstraintMatch> requiredConstrains)
void	setRunningInsideHandler(boolean runningInsideHandler)
void	setServletPathMatch(ServletPathMatch servletPathMatch)
void	setServletRequest(jakarta.servlet.ServletRequest servletRequest)
void	setServletResponse(jakarta.servlet.ServletResponse servletResponse)
void	setSession(HttpSessionImpl session)
void	setTransportGuarenteeType(TransportGuaranteeType transportGuarenteeType)

Methods inherited from class java.lang.Object

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

Field Detail

ATTACHMENT_KEY

public static final io.undertow.util.AttachmentKey<ServletRequestContext> ATTACHMENT_KEY

Constructor Detail

ServletRequestContext

public ServletRequestContext(Deployment deployment,
                             HttpServletRequestImpl originalRequest,
                             HttpServletResponseImpl originalResponse,
                             ServletPathMatch originalServletPathMatch)

Method Detail

setCurrentRequestContext

public static void setCurrentRequestContext(ServletRequestContext servletRequestContext)

clearCurrentServletAttachments

public static void clearCurrentServletAttachments()

requireCurrent

public static ServletRequestContext requireCurrent()

Gets the ServletRequestContext assigned to the current thread.

Returns:

The current ServletRequestContext based on the calling thread

Throws:

java.lang.IllegalStateException - if the calling thread does not have a ServletRequestContext set

See Also:

current()

current

public static ServletRequestContext current()

Gets the current threads ServletRequestContext if set, otherwise null.

Returns:

The current ServletRequestContext based on the calling thread, or null if unavailable

getDeployment

public Deployment getDeployment()

getCurrentServlet

public ServletChain getCurrentServlet()

setCurrentServlet

public void setCurrentServlet(ServletChain currentServlet)

getServletPathMatch

public ServletPathMatch getServletPathMatch()

setServletPathMatch

public void setServletPathMatch(ServletPathMatch servletPathMatch)

getRequiredConstrains

public java.util.List<SingleConstraintMatch> getRequiredConstrains()

setRequiredConstrains

public void setRequiredConstrains(java.util.List<SingleConstraintMatch> requiredConstrains)

getTransportGuarenteeType

public TransportGuaranteeType getTransportGuarenteeType()

setTransportGuarenteeType

public void setTransportGuarenteeType(TransportGuaranteeType transportGuarenteeType)

getServletResponse

public jakarta.servlet.ServletResponse getServletResponse()

setServletResponse

public void setServletResponse(jakarta.servlet.ServletResponse servletResponse)

getServletRequest

public jakarta.servlet.ServletRequest getServletRequest()

setServletRequest

public void setServletRequest(jakarta.servlet.ServletRequest servletRequest)

getDispatcherType

public jakarta.servlet.DispatcherType getDispatcherType()

setDispatcherType

public void setDispatcherType(jakarta.servlet.DispatcherType dispatcherType)

getOriginalRequest

public HttpServletRequestImpl getOriginalRequest()

getOriginalResponse

public HttpServletResponseImpl getOriginalResponse()

getSession

public HttpSessionImpl getSession()

setSession

public void setSession(HttpSessionImpl session)

getExchange

public io.undertow.server.HttpServerExchange getExchange()

getOriginalServletPathMatch

public ServletPathMatch getOriginalServletPathMatch()

getCurrentServletContext

public ServletContextImpl getCurrentServletContext()

setCurrentServletContext

public void setCurrentServletContext(ServletContextImpl currentServletContext)

displayStackTraces

public boolean displayStackTraces()

setError

public void setError(int sc,
                     java.lang.String msg)

getErrorCode

public int getErrorCode()

getErrorMessage

public java.lang.String getErrorMessage()

isRunningInsideHandler

public boolean isRunningInsideHandler()

setRunningInsideHandler

public void setRunningInsideHandler(boolean runningInsideHandler)

isAsyncSupported

public boolean isAsyncSupported()

getOverridenSessionId

public java.lang.String getOverridenSessionId()

setOverridenSessionId

public void setOverridenSessionId(java.lang.String overridenSessionId)

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)