Package org.jboss.resteasy.reactive.server.core

Class ResteasyReactiveRequestContext

java.lang.Object

org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

org.jboss.resteasy.reactive.server.core.ResteasyReactiveRequestContext

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, org.jboss.resteasy.reactive.common.core.ResteasyReactiveCallbackContext, ResteasyReactiveInjectionContext, ServerRequestContext

public abstract class ResteasyReactiveRequestContext
extends org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>
implements Closeable, ResteasyReactiveInjectionContext, ServerRequestContext

Field Summary

Fields

Modifier and Type	Field	Description
protected final Deployment	deployment
static final Object[]	EMPTY_ARRAY

Fields inherited from class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext

abortHandlerChain, CUSTOM_RR_PROPERTIES_PREFIX, handlers, log, logWebApplicationExceptions, position, throwable

Constructor Summary

Constructors

Constructor	Description
ResteasyReactiveRequestContext(Deployment deployment, org.jboss.resteasy.reactive.spi.ThreadSetupAction requestContext, ServerRestHandler[] handlerChain, ServerRestHandler[] abortHandlerChain)

Method Summary

Modifier and Type	Method	Description
void	abortWith(jakarta.ws.rs.core.Response response)	Meant to be used when an error occurred early in processing chain
void	close()
protected jakarta.ws.rs.core.SecurityContext	createSecurityContext()
protected void	endResponse()
String	getAbsoluteURI()
Annotation[]	getAdditionalAnnotations()
Annotation[]	getAllAnnotations()
jakarta.ws.rs.core.MultivaluedMap<String,String>	getAllPathParameters(boolean encoded)	Collects all path parameters, first from the current RuntimeResource, also known as target, and then from the previous RuntimeResources, including path parameters from sub resource locators in the process.
AsyncResponseImpl	getAsyncResponse()
String	getAuthority()
<T> T	getBeanParameter(Class<T> type)	Gets the bean parameter instance by type via CDI, and registers a cleanup for it.
ContainerRequestContextImpl	getContainerRequestContext()
ContainerResponseContextImpl	getContainerResponseContext()
<T> T	getContextParameter(Class<T> type)	Gets the context parameter instance by type for predefined types, also calls unwrap, and CDI.
String	getCookieParameter(String name)
Deployment	getDeployment()
Object	getEndpointInstance()
EntityWriter	getEntityWriter()
protected abstract Executor	getEventLoop()
FormData	getFormData()
Object	getFormParameter(String name, boolean single, boolean encoded)
Type	getGenericReturnType()
Object	getHeader(String name, boolean single)
HttpHeadersImpl	getHttpHeaders()
InputStream	getInputStream()
List<UriMatch>	getMatchedURIs()
Object	getMatrixParameter(String name, boolean single, boolean encoded)
String	getMethod()
Annotation[]	getMethodAnnotations()
OutputStream	getOrCreateOutputStream()
OutputStream	getOutputStream()
Object[]	getParameters()
String	getPath()	Returns the normalised non-decoded path including any prefix.
String	getPathParam(int index, boolean encoded)
String	getPathParameter(String name, boolean encoded)
List<jakarta.ws.rs.core.PathSegment>	getPathSegments()	Return the path segments
String	getPathWithoutPrefix()	Returns the normalised non-decoded path excluding any prefix.
ProvidersImpl	getProviders()
Object	getQueryParameter(String name, boolean single, boolean encoded)
Object	getQueryParameter(String name, boolean single, boolean encoded, String separator)
jakarta.ws.rs.ext.ReaderInterceptor[]	getReaderInterceptors()
String	getRemaining()
jakarta.ws.rs.core.Request	getRequest()
Object	getRequestEntity()
jakarta.ws.rs.core.HttpHeaders	getRequestHeaders()
String	getResourceLocatorPathParam(String name, boolean encoded)
LazyResponse	getResponse()
EncodedMediaType	getResponseContentType()	Returns the current response content type.
Object	getResponseEntity()
jakarta.ws.rs.core.MediaType	getResponseMediaType()
ResteasyReactiveResourceInfo	getResteasyReactiveResourceInfo()
Object	getResult()
String	getScheme()
jakarta.ws.rs.core.SecurityContext	getSecurityContext()
SseEventSinkImpl	getSseEventSink()
RuntimeResource	getTarget()
Throwable	getThrowable()
jakarta.ws.rs.core.UriInfo	getUriInfo()
jakarta.ws.rs.ext.WriterInterceptor[]	getWriterInterceptors()
protected void	handleRequestScopeActivation()
boolean	handlesUnmappedException()
void	handleUnmappedException(Throwable throwable)
protected void	handleUnrecoverableError(Throwable throwable)
boolean	hasGenericReturnType()
boolean	hasInputStream()
void	initPathSegments()	initializes the path segments and removes any matrix params for the path used for matching.
boolean	isProducesChecked()
boolean	isSecurityContextSet()
void	mapExceptionIfPresent()
abstract Runnable	registerTimer(long millis, Runnable task)
protected void	requestScopeDeactivated()
void	resetBuildTimeSerialization()	Resets the build time serialization assumptions.
void	restart(RuntimeResource target)	Restarts handler chain processing with a new chain targeting a new resource.
void	restart(RuntimeResource target, boolean setLocatorTarget)
protected void	restarted(boolean keepTarget)
boolean	restartWithNextInitialMatch()	Restarts handler chain processing if another initial match is found.
abstract boolean	resumeExternalProcessing()
void	saveUriMatchState()
protected void	securityContextUpdated(jakarta.ws.rs.core.SecurityContext securityContext)
abstract ServerHttpRequest	serverRequest()
abstract ServerHttpResponse	serverResponse()
void	setAdditionalAnnotations(Annotation[] additionalAnnotations)
void	setAllAnnotations(Annotation[] annotations)
ResteasyReactiveRequestContext	setAsyncResponse(AsyncResponseImpl asyncResponse)
ResteasyReactiveRequestContext	setEndpointInstance(Object endpointInstance)
ResteasyReactiveRequestContext	setEntityWriter(EntityWriter entityWriter)
ResteasyReactiveRequestContext	setFormData(FormData formData)
ResteasyReactiveRequestContext	setGenericReturnType(Type genericReturnType)
ResteasyReactiveRequestContext	setInputStream(InputStream inputStream)
void	setMaxPathParams(int maxPathParams)
void	setMethod(String method)
ResteasyReactiveRequestContext	setMethodAnnotations(Annotation[] methodAnnotations)
void	setOutputStream(OutputStream outputStream)
ResteasyReactiveRequestContext	setPathParamValue(int index, String value)
void	setProducesChecked(boolean checked)
protected void	setQueryParamsFrom(String uri)
ResteasyReactiveRequestContext	setReaderInterceptors(jakarta.ws.rs.ext.ReaderInterceptor[] readerInterceptors)
void	setRemaining(String remaining)
ResteasyReactiveRequestContext	setRequestEntity(Object requestEntity)
ResteasyReactiveRequestContext	setRequestUri(URI requestURI)
ResteasyReactiveRequestContext	setResponse(LazyResponse response)
ResteasyReactiveRequestContext	setResponseContentType(jakarta.ws.rs.core.MediaType responseContentType)
ResteasyReactiveRequestContext	setResponseContentType(EncodedMediaType responseContentType)
ResteasyReactiveRequestContext	setResult(Object result)
ResteasyReactiveRequestContext	setSecurityContext(jakarta.ws.rs.core.SecurityContext securityContext)
void	setSseEventSink(SseEventSinkImpl sseEventSink)
void	setupInitialMatchAndRestart(RequestMapper.RequestMatch<RestInitialHandler.InitialMatch> initialMatch)
void	setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)
ResteasyReactiveRequestContext	setWriterInterceptors(jakarta.ws.rs.ext.WriterInterceptor[] writerInterceptors)
<T> T	unwrap(Class<T> type)

Methods inherited from class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext

beginAsyncProcessing, captureCDIRequestScope, getAbortHandlerChain, getContextExecutor, getHandlers, getPosition, getProperty, getPropertyNames, handleException, handleException, invokeHandler, isRequestScopeManagementRequired, isSuspended, onPreRequestScopeActivation, registerCompletionCallback, registerConnectionCallback, removeProperty, requireCDIRequestScope, restart, restart, resume, resume, resume, resume, run, setAbortHandlerChain, setAbortHandlerChainStarted, setPosition, setProperty, setSuspended, suspend, unwrapException

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.resteasy.reactive.common.core.ResteasyReactiveCallbackContext

registerCompletionCallback, registerConnectionCallback

Field Details

EMPTY_ARRAY

public static final Object[] EMPTY_ARRAY

deployment

protected final Deployment deployment

Constructor Details

ResteasyReactiveRequestContext

public ResteasyReactiveRequestContext(Deployment deployment,
 org.jboss.resteasy.reactive.spi.ThreadSetupAction requestContext,
 ServerRestHandler[] handlerChain,
 ServerRestHandler[] abortHandlerChain)

Method Details

serverRequest

public abstract ServerHttpRequest serverRequest()

serverResponse

public abstract ServerHttpResponse serverResponse()

Specified by:

serverResponse in interface ServerRequestContext

getRequestHeaders

public jakarta.ws.rs.core.HttpHeaders getRequestHeaders()

Specified by:

getRequestHeaders in interface ServerRequestContext

getDeployment

public Deployment getDeployment()

getProviders

public ProvidersImpl getProviders()

restart

public void restart(RuntimeResource target)

Restarts handler chain processing with a new chain targeting a new resource.

Parameters:

target - The resource target

restart

public void restart(RuntimeResource target,
 boolean setLocatorTarget)

setupInitialMatchAndRestart

public void setupInitialMatchAndRestart(RequestMapper.RequestMatch<RestInitialHandler.InitialMatch> initialMatch)

restartWithNextInitialMatch

public boolean restartWithNextInitialMatch()

Restarts handler chain processing if another initial match is found.

Returns:

true if a restart occurred

abortWith

public void abortWith(jakarta.ws.rs.core.Response response)

Meant to be used when an error occurred early in processing chain

Specified by:

abortWith in interface ServerRequestContext

resetBuildTimeSerialization

public void resetBuildTimeSerialization()

Resets the build time serialization assumptions. Called if a filter modifies the response

getUriInfo

public jakarta.ws.rs.core.UriInfo getUriInfo()

getHttpHeaders

public HttpHeadersImpl getHttpHeaders()

getParameters

public Object[] getParameters()

setMaxPathParams

public void setMaxPathParams(int maxPathParams)

getPathParam

public String getPathParam(int index,
 boolean encoded)

setPathParamValue

public ResteasyReactiveRequestContext setPathParamValue(int index,
 String value)

setUriInfo

public void setUriInfo(jakarta.ws.rs.core.UriInfo uriInfo)

getRequestEntity

public Object getRequestEntity()

setRequestEntity

public ResteasyReactiveRequestContext setRequestEntity(Object requestEntity)

getEntityWriter

public EntityWriter getEntityWriter()

setEntityWriter

public ResteasyReactiveRequestContext setEntityWriter(EntityWriter entityWriter)

getEndpointInstance

public Object getEndpointInstance()

setEndpointInstance

public ResteasyReactiveRequestContext setEndpointInstance(Object endpointInstance)

getResult

public Object getResult()

getThrowable

public Throwable getThrowable()

Overrides:

getThrowable in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

getResponseEntity

public Object getResponseEntity()

setResult

public ResteasyReactiveRequestContext setResult(Object result)

handlesUnmappedException

public boolean handlesUnmappedException()

handleUnmappedException

public void handleUnmappedException(Throwable throwable)

getTarget

public RuntimeResource getTarget()

mapExceptionIfPresent

public void mapExceptionIfPresent()

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

getResponse

public LazyResponse getResponse()

setResponse

public ResteasyReactiveRequestContext setResponse(LazyResponse response)

getRequest

public jakarta.ws.rs.core.Request getRequest()

getContainerRequestContext

public ContainerRequestContextImpl getContainerRequestContext()

getContainerResponseContext

public ContainerResponseContextImpl getContainerResponseContext()

getMethod

public String getMethod()

setMethod

public void setMethod(String method)

setRemaining

public void setRemaining(String remaining)

getRemaining

public String getRemaining()

getPathWithoutPrefix

public String getPathWithoutPrefix()

Returns the normalised non-decoded path excluding any prefix.

getPath

public String getPath()

Returns the normalised non-decoded path including any prefix.

getAbsoluteURI

public String getAbsoluteURI()

getScheme

public String getScheme()

getAuthority

public String getAuthority()

setRequestUri

public ResteasyReactiveRequestContext setRequestUri(URI requestURI)

setQueryParamsFrom

protected void setQueryParamsFrom(String uri)

getResponseContentType

public EncodedMediaType getResponseContentType()

Returns the current response content type. If a response has been set and has an explicit content type then this is used, otherwise it returns any content type that has been explicitly set.

Specified by:

getResponseContentType in interface ServerRequestContext

getResponseMediaType

public jakarta.ws.rs.core.MediaType getResponseMediaType()

Specified by:

getResponseMediaType in interface ServerRequestContext

setResponseContentType

public ResteasyReactiveRequestContext setResponseContentType(EncodedMediaType responseContentType)

setResponseContentType

public ResteasyReactiveRequestContext setResponseContentType(jakarta.ws.rs.core.MediaType responseContentType)

getAllAnnotations

public Annotation[] getAllAnnotations()

setAllAnnotations

public void setAllAnnotations(Annotation[] annotations)

getMethodAnnotations

public Annotation[] getMethodAnnotations()

setMethodAnnotations

public ResteasyReactiveRequestContext setMethodAnnotations(Annotation[] methodAnnotations)

getAdditionalAnnotations

public Annotation[] getAdditionalAnnotations()

setAdditionalAnnotations

public void setAdditionalAnnotations(Annotation[] additionalAnnotations)

hasGenericReturnType

public boolean hasGenericReturnType()

getGenericReturnType

public Type getGenericReturnType()

setGenericReturnType

public ResteasyReactiveRequestContext setGenericReturnType(Type genericReturnType)

getAsyncResponse

public AsyncResponseImpl getAsyncResponse()

setAsyncResponse

public ResteasyReactiveRequestContext setAsyncResponse(AsyncResponseImpl asyncResponse)

getReaderInterceptors

public jakarta.ws.rs.ext.ReaderInterceptor[] getReaderInterceptors()

setReaderInterceptors

public ResteasyReactiveRequestContext setReaderInterceptors(jakarta.ws.rs.ext.ReaderInterceptor[] readerInterceptors)

getWriterInterceptors

public jakarta.ws.rs.ext.WriterInterceptor[] getWriterInterceptors()

setWriterInterceptors

public ResteasyReactiveRequestContext setWriterInterceptors(jakarta.ws.rs.ext.WriterInterceptor[] writerInterceptors)

handleUnrecoverableError

protected void handleUnrecoverableError(Throwable throwable)

Specified by:

handleUnrecoverableError in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

endResponse

protected void endResponse()

handleRequestScopeActivation

protected void handleRequestScopeActivation()

Specified by:

handleRequestScopeActivation in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

requestScopeDeactivated

protected void requestScopeDeactivated()

Overrides:

requestScopeDeactivated in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

restarted

protected void restarted(boolean keepTarget)

Specified by:

restarted in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

saveUriMatchState

public void saveUriMatchState()

getMatchedURIs

public List<UriMatch> getMatchedURIs()

hasInputStream

public boolean hasInputStream()

getInputStream

public InputStream getInputStream()

Specified by:

getInputStream in interface ServerRequestContext

setInputStream

public ResteasyReactiveRequestContext setInputStream(InputStream inputStream)

getSseEventSink

public SseEventSinkImpl getSseEventSink()

setSseEventSink

public void setSseEventSink(SseEventSinkImpl sseEventSink)

getPathSegments

public List<jakarta.ws.rs.core.PathSegment> getPathSegments()

Return the path segments

This is lazily initialized

initPathSegments

public void initPathSegments()

initializes the path segments and removes any matrix params for the path used for matching.

setProducesChecked

public void setProducesChecked(boolean checked)

isProducesChecked

public boolean isProducesChecked()

getHeader

public Object getHeader(String name,
 boolean single)

Specified by:

getHeader in interface ResteasyReactiveInjectionContext

getQueryParameter

public Object getQueryParameter(String name,
 boolean single,
 boolean encoded)

getQueryParameter

public Object getQueryParameter(String name,
 boolean single,
 boolean encoded,
 String separator)

Specified by:

getQueryParameter in interface ResteasyReactiveInjectionContext

getMatrixParameter

public Object getMatrixParameter(String name,
 boolean single,
 boolean encoded)

Specified by:

getMatrixParameter in interface ResteasyReactiveInjectionContext

getCookieParameter

public String getCookieParameter(String name)

Specified by:

getCookieParameter in interface ResteasyReactiveInjectionContext

getFormParameter

public Object getFormParameter(String name,
 boolean single,
 boolean encoded)

Specified by:

getFormParameter in interface ResteasyReactiveInjectionContext

getBeanParameter

public <T> T getBeanParameter(Class<T> type)

Description copied from interface: ResteasyReactiveInjectionContext

Gets the bean parameter instance by type via CDI, and registers a cleanup for it. This does not call __inject on it, and it does not work for records (which cannot be gotten via CDI).

Specified by:

getBeanParameter in interface ResteasyReactiveInjectionContext

getContextParameter

public <T> T getContextParameter(Class<T> type)

Description copied from interface: ResteasyReactiveInjectionContext

Gets the context parameter instance by type for predefined types, also calls unwrap, and CDI.

Specified by:

getContextParameter in interface ResteasyReactiveInjectionContext

getPathParameter

public String getPathParameter(String name,
 boolean encoded)

Specified by:

getPathParameter in interface ResteasyReactiveInjectionContext

unwrap

public <T> T unwrap(Class<T> type)

Specified by:

unwrap in interface ResteasyReactiveInjectionContext

getSecurityContext

public jakarta.ws.rs.core.SecurityContext getSecurityContext()

isSecurityContextSet

public boolean isSecurityContextSet()

createSecurityContext

protected jakarta.ws.rs.core.SecurityContext createSecurityContext()

setSecurityContext

public ResteasyReactiveRequestContext setSecurityContext(jakarta.ws.rs.core.SecurityContext securityContext)

securityContextUpdated

protected void securityContextUpdated(jakarta.ws.rs.core.SecurityContext securityContext)

setOutputStream

public void setOutputStream(OutputStream outputStream)

getOutputStream

public OutputStream getOutputStream()

getOrCreateOutputStream

public OutputStream getOrCreateOutputStream()

Specified by:

getOrCreateOutputStream in interface ServerRequestContext

getResteasyReactiveResourceInfo

public ResteasyReactiveResourceInfo getResteasyReactiveResourceInfo()

Specified by:

getResteasyReactiveResourceInfo in interface ServerRequestContext

getEventLoop

protected abstract Executor getEventLoop()

Specified by:

getEventLoop in class org.jboss.resteasy.reactive.common.core.AbstractResteasyReactiveContext<ResteasyReactiveRequestContext,ServerRestHandler>

registerTimer

public abstract Runnable registerTimer(long millis,
 Runnable task)

getResourceLocatorPathParam

public String getResourceLocatorPathParam(String name,
 boolean encoded)

getAllPathParameters

public jakarta.ws.rs.core.MultivaluedMap<String,String> getAllPathParameters(boolean encoded)

Collects all path parameters, first from the current RuntimeResource, also known as target, and then from the previous RuntimeResources, including path parameters from sub resource locators in the process.

Parameters:

encoded -

Returns:

MultivaluedMap with path parameters. May be empty, but is never null

getFormData

public FormData getFormData()

setFormData

public ResteasyReactiveRequestContext setFormData(FormData formData)

resumeExternalProcessing

public abstract boolean resumeExternalProcessing()