ServletRequestContext (Undertow 2.1.0.Final API)

java.lang.Object
- io.undertow.servlet.handlers.ServletRequestContext

```
public class ServletRequestContext
extends 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 and Description

static AttachmentKey<ServletRequestContext> ATTACHMENT_KEY

Fields
Modifier and Type	Field and Description
`static AttachmentKey<ServletRequestContext>`	`ATTACHMENT_KEY`

Constructor Summary

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`clearCurrentServletAttachments()`
`static ServletRequestContext`	`current()` Gets the current threads `ServletRequestContext` if set, otherwise null.
`boolean`	`displayStackTraces()`
`ServletChain`	`getCurrentServlet()`
`ServletContextImpl`	`getCurrentServletContext()`
`Deployment`	`getDeployment()`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`int`	`getErrorCode()`
`String`	`getErrorMessage()`
`HttpServerExchange`	`getExchange()`
`HttpServletRequestImpl`	`getOriginalRequest()`
`HttpServletResponseImpl`	`getOriginalResponse()`
`ServletPathMatch`	`getOriginalServletPathMatch()`
`String`	`getOverridenSessionId()`
`List<SingleConstraintMatch>`	`getRequiredConstrains()`
`ServletPathMatch`	`getServletPathMatch()`
`javax.servlet.ServletRequest`	`getServletRequest()`
`javax.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(javax.servlet.DispatcherType dispatcherType)`
`void`	`setError(int sc, String msg)`
`void`	`setOverridenSessionId(String overridenSessionId)`
`void`	`setRequiredConstrains(List<SingleConstraintMatch> requiredConstrains)`
`void`	`setRunningInsideHandler(boolean runningInsideHandler)`
`void`	`setServletPathMatch(ServletPathMatch servletPathMatch)`
`void`	`setServletRequest(javax.servlet.ServletRequest servletRequest)`
`void`	`setServletResponse(javax.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 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:

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 List<SingleConstraintMatch> getRequiredConstrains()

setRequiredConstrains

public void setRequiredConstrains(List<SingleConstraintMatch> requiredConstrains)

getTransportGuarenteeType

public TransportGuaranteeType getTransportGuarenteeType()

setTransportGuarenteeType

public void setTransportGuarenteeType(TransportGuaranteeType transportGuarenteeType)

getServletResponse

public javax.servlet.ServletResponse getServletResponse()

setServletResponse

public void setServletResponse(javax.servlet.ServletResponse servletResponse)

getServletRequest

public javax.servlet.ServletRequest getServletRequest()

setServletRequest

public void setServletRequest(javax.servlet.ServletRequest servletRequest)

getDispatcherType

public javax.servlet.DispatcherType getDispatcherType()

setDispatcherType

public void setDispatcherType(javax.servlet.DispatcherType dispatcherType)

getOriginalRequest

public HttpServletRequestImpl getOriginalRequest()

getOriginalResponse

public HttpServletResponseImpl getOriginalResponse()

getSession
```
public HttpSessionImpl getSession()
```

setSession

public void setSession(HttpSessionImpl session)

getExchange

public 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,
                     String msg)

getErrorCode
```
public int getErrorCode()
```

getErrorMessage
```
public String getErrorMessage()
```

isRunningInsideHandler

public boolean isRunningInsideHandler()

setRunningInsideHandler

public void setRunningInsideHandler(boolean runningInsideHandler)

isAsyncSupported
```
public boolean isAsyncSupported()
```

getOverridenSessionId
```
public String getOverridenSessionId()
```

setOverridenSessionId

public void setOverridenSessionId(String overridenSessionId)

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)

Class ServletRequestContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTACHMENT_KEY

Constructor Detail

ServletRequestContext

Method Detail

setCurrentRequestContext

clearCurrentServletAttachments

requireCurrent

current

getDeployment

getCurrentServlet

setCurrentServlet

getServletPathMatch

setServletPathMatch

getRequiredConstrains

setRequiredConstrains

getTransportGuarenteeType

setTransportGuarenteeType

getServletResponse

setServletResponse

getServletRequest

setServletRequest

getDispatcherType

setDispatcherType

getOriginalRequest

getOriginalResponse

getSession

setSession

getExchange

getOriginalServletPathMatch

getCurrentServletContext

setCurrentServletContext

displayStackTraces

setError

getErrorCode

getErrorMessage

isRunningInsideHandler

setRunningInsideHandler

isAsyncSupported

getOverridenSessionId

setOverridenSessionId

setAsyncSupported