Package org.jboss.resteasy.core

Class ThreadLocalResteasyProviderFactory

java.lang.Object

jakarta.ws.rs.ext.RuntimeDelegate

org.jboss.resteasy.spi.ResteasyProviderFactory

org.jboss.resteasy.core.providerfactory.ResteasyProviderFactoryImpl

org.jboss.resteasy.core.ThreadLocalResteasyProviderFactory

All Implemented Interfaces:

Configurable<ResteasyProviderFactory>, Configuration, Providers, HeaderValueProcessor, ProviderFactoryDelegate

public final class ThreadLocalResteasyProviderFactory
extends ResteasyProviderFactoryImpl
implements ProviderFactoryDelegate

Allow applications to push/pop provider factories onto the stack.

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested classes/interfaces inherited from class jakarta.ws.rs.ext.RuntimeDelegate

RuntimeDelegate.HeaderDelegate<T>

Field Summary

Fields inherited from class org.jboss.resteasy.core.providerfactory.ResteasyProviderFactoryImpl

alreadyEstablishedNullHeaderDelegate, asyncContextInjectors, attachedContextResolvers, attachedParamConverterProviders, builtinsRegistered, classContracts, clientHelper, contextInjectors, contextResolvers, enabledFeatures, headerDelegates, initialized, injectorFactory, lockSnapshots, properties, providerClasses, providerInstances, registerBuiltins, resourceBuilder, serverHelper, sortedParamConverterProviders, statisticsController, stringParameterUnmarshallers

Fields inherited from class jakarta.ws.rs.ext.RuntimeDelegate

JAXRS_RUNTIME_DELEGATE_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ThreadLocalResteasyProviderFactory(ResteasyProviderFactory defaultFactory)
ThreadLocalResteasyProviderFactory(ResteasyProviderFactory defaultFactory, boolean defaultExceptionManagerEnabled)	Creates a new thread local provider.

Method Summary

Modifier and Type	Method	Description
void	addHeaderDelegate(Class clazz, RuntimeDelegate.HeaderDelegate header)
<T> T	createEndpoint(Application applicationConfig, Class<T> endpointType)	This is a spec method that is unsupported.
<T> RuntimeDelegate.HeaderDelegate<T>	createHeaderDelegate(Class<T> tClass)	Obtain an instance of a RuntimeDelegate.HeaderDelegate for the supplied class.
Link.Builder	createLinkBuilder()	Create a new instance of a Link.Builder.
<T> T	createProviderInstance(Class<? extends T> clazz)	Create an instance of a class using provider allocation rules of the specification as well as the InjectorFactory only does constructor injection.
Response.ResponseBuilder	createResponseBuilder()	Create a new instance of a Response.ResponseBuilder.
<T> StringParameterUnmarshaller<T>	createStringParameterUnmarshaller(Class<T> clazz)
UriBuilder	createUriBuilder()	Create a new instance of a UriBuilder.
Variant.VariantListBuilder	createVariantListBuilder()	Create a new instance of a Variant.VariantListBuilder.
Map<Type,ContextInjector>	getAsyncContextInjectors()
<T> AsyncResponseProvider<T>	getAsyncResponseProvider(Class<T> type)
Map<Class<?>,AsyncResponseProvider>	getAsyncResponseProviders()
<T> AsyncStreamProvider<T>	getAsyncStreamProvider(Class<T> type)
Map<Class<?>,AsyncStreamProvider>	getAsyncStreamProviders()
Set<Class<?>>	getClasses()	Get the immutable set of registered JAX-RS component (such as provider, root resource or feature) classes to be instantiated, injected and utilized in the scope of the configurable instance.
Set<DynamicFeature>	getClientDynamicFeatures()
<T> MessageBodyReader<T>	getClientMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType)
<T> MessageBodyWriter<T>	getClientMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType)
JaxrsInterceptorRegistry<ReaderInterceptor>	getClientReaderInterceptorRegistry()
JaxrsInterceptorRegistry<ClientRequestFilter>	getClientRequestFilterRegistry()
JaxrsInterceptorRegistry<ClientResponseFilter>	getClientResponseFilters()
JaxrsInterceptorRegistry<WriterInterceptor>	getClientWriterInterceptorRegistry()
MediaType	getConcreteMediaTypeFromMessageBodyWriters(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType)
Configuration	getConfiguration()	Get a live view of an internal configuration state of this configurable instance.
JaxrsInterceptorRegistry<ContainerRequestFilter>	getContainerRequestFilterRegistry()
JaxrsInterceptorRegistry<ContainerResponseFilter>	getContainerResponseFilterRegistry()
<T> T	getContextData(Class<T> rawType, Type genericType, Annotation[] annotations, boolean unwrapAsync)
Map<Type,ContextInjector>	getContextInjectors()
<T> ContextResolver<T>	getContextResolver(Class<T> contextType, MediaType mediaType)	Get a context resolver for a particular type of context and media type.
List<ContextResolver>	getContextResolvers(Class<?> clazz, MediaType type)
Map<Class<?>,Integer>	getContracts(Class<?> componentClass)	Get the extension contract registration information for a component of a given class.
ResteasyProviderFactory	getDelegate()
Collection<Feature>	getEnabledFeatures()
<T extends Throwable> ExceptionMapper<T>	getExceptionMapper(Class<T> type)	Get an exception mapping provider for a particular class of exception.
RuntimeDelegate.HeaderDelegate<?>	getHeaderDelegate(Class<?> aClass)	Checks to see if RuntimeDelegate is a ResteasyProviderFactory If it is, then use that, otherwise use this.
InjectorFactory	getInjectorFactory()
Set<Object>	getInstances()	Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be utilized by the configurable instance.
<T> MessageBodyReader<T>	getMessageBodyReader(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType)	Always returns server MBRs.
<T> MessageBodyWriter<T>	getMessageBodyWriter(Class<T> type, Type genericType, Annotation[] annotations, MediaType mediaType)	Always gets server MBW.
Map<String,Object>	getMutableProperties()
ParamConverter	getParamConverter(Class clazz, Type genericType, Annotation[] annotations)
Map<String,Object>	getProperties()	Get the immutable bag of configuration properties.
Object	getProperty(String name)	Get the value for the property with a given name.
Collection<String>	getPropertyNames()	Returns an immutable collection containing the property names available within the context of the current configuration instance.
Set<Class<?>>	getProviderClasses()	Gets provide classes.
Set<Object>	getProviderInstances()	Gets provider instances.
RuntimeType	getRuntimeType()	Get the runtime type of this configuration context.
Set<DynamicFeature>	getServerDynamicFeatures()
JaxrsInterceptorRegistry<ReaderInterceptor>	getServerReaderInterceptorRegistry()
JaxrsInterceptorRegistry<WriterInterceptor>	getServerWriterInterceptorRegistry()
ExceptionMapper<Throwable>	getThrowableExceptionMapper()	Returns an exception mapper which handles the generic throwable which is typically the default exception mapper.
protected void	initialize()
<T> T	injectedInstance(Class<? extends T> clazz)	Property and constructor injection using the InjectorFactory.
<T> T	injectedInstance(Class<? extends T> clazz, HttpRequest request, HttpResponse response)	Property and constructor injection using the InjectorFactory.
void	injectProperties(Object obj)
void	injectProperties(Object obj, HttpRequest request, HttpResponse response)
boolean	isBuiltinsRegistered()
boolean	isEnabled(Feature feature)	Check if a particular feature instance has been previously enabled in the runtime configuration context.
boolean	isEnabled(Class<? extends Feature> featureClass)	Check if a feature instance of featureClass class has been previously enabled in the runtime configuration context.
boolean	isRegisterBuiltins()
boolean	isRegistered(Class<?> componentClass)	Check if a JAX-RS component of the supplied componentClass class has been previously registered in the runtime configuration context.
boolean	isRegistered(Object component)	Check if a particular JAX-RS component instance (such as providers or features) has been previously registered in the runtime configuration context.
static void	pop()
ResteasyProviderFactory	property(String name, Object value)	Set the new configuration property, if already set, the existing value of the property will be updated.
static void	push(ResteasyProviderFactory factory)
ResteasyProviderFactory	register(Class<?> providerClass)	Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Class<?> componentClass, int priority)	Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Class<?> componentClass, Class<?>... contracts)	Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Class<?> componentClass, Map<Class<?>,Integer> contracts)	Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Object provider)	Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Object component, int priority)	Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Object component, Class<?>... contracts)	Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
ResteasyProviderFactory	register(Object component, Map<Class<?>,Integer> contracts)	Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.
void	registerProvider(Class provider)
void	registerProvider(Class provider, boolean isBuiltin)	Register a @Provider class.
void	registerProvider(Class provider, Integer priorityOverride, boolean isBuiltin, Map<Class<?>,Integer> contracts)
void	registerProviderInstance(Object provider)	Register a @Provider object.
void	registerProviderInstance(Object provider, Map<Class<?>,Integer> contracts, Integer defaultPriority, boolean builtIn)
void	setBuiltinsRegistered(boolean builtinsRegistered)
void	setInjectorFactory(InjectorFactory injectorFactory)
ResteasyProviderFactory	setProperties(Map<String,Object> properties)
void	setRegisterBuiltins(boolean registerBuiltins)
String	toHeaderString(Object object)	Convert an object to a header string.
String	toString(Object object, Class clazz, Type genericType, Annotation[] annotations)	Convert an object to a string.

Methods inherited from class org.jboss.resteasy.core.providerfactory.ResteasyProviderFactoryImpl

addContextInjector, addContextResolver, addFeature, addHeaderDelegate, addHeaderDelegate, addHeaderDelegateIfAbsent, addInjectorFactory, addParameterConverterProvider, addResourceClassProcessor, addStringParameterUnmarshaller, bootstrap, bootstrap, createConfigurationBuilder, createEntityPartBuilder, getAsyncClientResponseProvider, getAsyncClientResponseProviders, getClassContracts, getClientHelper, getClientMessageBodyReaders, getClientMessageBodyWriters, getContextData, getContextResolvers, getExceptionMapperForClass, getHeaderDelegates, getMutableProviderClasses, getPossibleMessageBodyWritersMap, getResourceBuilder, getRxInvokerProvider, getRxInvokerProviderFromReactiveClass, getServerHelper, getServerMessageBodyReader, getServerMessageBodyReader, getServerMessageBodyReaders, getServerMessageBodyWriter, getServerMessageBodyWriter, getServerMessageBodyWriters, getSortedParamConverterProviders, getStatisticsController, getStringParameterUnmarshallers, hasProperty, initializeClientProviders, initializeCommon, isDefaultExceptionManagerEnabled, isOnServer, isReactive, lockSnapshots, registerBuiltin

Methods inherited from class org.jboss.resteasy.spi.ResteasyProviderFactory

clearInstanceIfEqual, getInstance, isA, isA, newInstance, peekInstance, setInstance, setRegisterBuiltinByDefault

Methods inherited from class jakarta.ws.rs.ext.RuntimeDelegate

setInstance

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadLocalResteasyProviderFactory

public ThreadLocalResteasyProviderFactory(ResteasyProviderFactory defaultFactory)

ThreadLocalResteasyProviderFactory

public ThreadLocalResteasyProviderFactory(ResteasyProviderFactory defaultFactory,
 boolean defaultExceptionManagerEnabled)

Creates a new thread local provider.

Parameters:

defaultFactory - the delegate provider

defaultExceptionManagerEnabled - true if the default exception manager should be enabled

Method Details

getDelegate

public ResteasyProviderFactory getDelegate()

Specified by:

getDelegate in interface ProviderFactoryDelegate

initialize

protected void initialize()

Overrides:

initialize in class ResteasyProviderFactoryImpl

getConcreteMediaTypeFromMessageBodyWriters

public MediaType getConcreteMediaTypeFromMessageBodyWriters(Class<?> type,
 Type genericType,
 Annotation[] annotations,
 MediaType mediaType)

Overrides:

getConcreteMediaTypeFromMessageBodyWriters in class ResteasyProviderFactoryImpl

getHeaderDelegate

public RuntimeDelegate.HeaderDelegate<?> getHeaderDelegate(Class<?> aClass)

Description copied from class: ResteasyProviderFactoryImpl

Checks to see if RuntimeDelegate is a ResteasyProviderFactory If it is, then use that, otherwise use this.

Overrides:

getHeaderDelegate in class ResteasyProviderFactoryImpl

Parameters:

aClass - class of the header

Returns:

header delegate

injectedInstance

public <T> T injectedInstance(Class<? extends T> clazz,
 HttpRequest request,
 HttpResponse response)

Description copied from class: ResteasyProviderFactoryImpl

Property and constructor injection using the InjectorFactory.

Overrides:

injectedInstance in class ResteasyProviderFactoryImpl

Type Parameters:

T - type

Parameters:

clazz - class

request - http request

response - http response

Returns:

instance of type T

injectProperties

public void injectProperties(Object obj,
 HttpRequest request,
 HttpResponse response)

Overrides:

injectProperties in class ResteasyProviderFactoryImpl

push

public static void push(ResteasyProviderFactory factory)

pop

public static void pop()

getContainerResponseFilterRegistry

public JaxrsInterceptorRegistry<ContainerResponseFilter> getContainerResponseFilterRegistry()

Overrides:

getContainerResponseFilterRegistry in class ResteasyProviderFactoryImpl

getServerReaderInterceptorRegistry

public JaxrsInterceptorRegistry<ReaderInterceptor> getServerReaderInterceptorRegistry()

Overrides:

getServerReaderInterceptorRegistry in class ResteasyProviderFactoryImpl

createVariantListBuilder

public Variant.VariantListBuilder createVariantListBuilder()

Description copied from class: RuntimeDelegate

Create a new instance of a Variant.VariantListBuilder.

Overrides:

createVariantListBuilder in class ResteasyProviderFactoryImpl

Returns:

new VariantListBuilder instance.

See Also:

• Variant.VariantListBuilder

getContextResolvers

public List<ContextResolver> getContextResolvers(Class<?> clazz,
 MediaType type)

Overrides:

getContextResolvers in class ResteasyProviderFactoryImpl

isBuiltinsRegistered

public boolean isBuiltinsRegistered()

Overrides:

isBuiltinsRegistered in class ResteasyProviderFactoryImpl

setBuiltinsRegistered

public void setBuiltinsRegistered(boolean builtinsRegistered)

Overrides:

setBuiltinsRegistered in class ResteasyProviderFactoryImpl

register

public ResteasyProviderFactory register(Class<?> providerClass)

Description copied from interface: Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context. Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS implementation and a warning SHOULD be raised to inform the user about the rejected registration. The registered JAX-RS component class is registered as a contract provider of all the recognized JAX-RS or implementation-specific extension contracts including meta-provider contracts, such as Feature or DynamicFeature.

As opposed to component instances registered via Configurable.register(Object) method, the lifecycle of components registered using this class-based register(...) method is fully managed by the JAX-RS implementation or any underlying IoC container supported by the implementation.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

providerClass - JAX-RS component class to be configured in the scope of this configurable context.

Returns:

the updated configurable context.

getClientDynamicFeatures

public Set<DynamicFeature> getClientDynamicFeatures()

Overrides:

getClientDynamicFeatures in class ResteasyProviderFactoryImpl

register

public ResteasyProviderFactory register(Class<?> componentClass,
 Map<Class<?>,Integer> contracts)

Description copied from interface: Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides same functionality as Configurable.register(Class, Class[]) except that any priority specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden for each extension provider contract type separately with an integer priority value specified as a value in the supplied map of [contract type, priority] pairs.

Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the supplied priority value is ignored for such contract.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

componentClass - JAX-RS component class to be configured in the scope of this configurable context.

contracts - map of the specific extension provider and meta-provider contracts and their associated priorities for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Returns:

the updated configurable context.

getEnabledFeatures

public Collection<Feature> getEnabledFeatures()

Overrides:

getEnabledFeatures in class ResteasyProviderFactoryImpl

createResponseBuilder

public Response.ResponseBuilder createResponseBuilder()

Description copied from class: RuntimeDelegate

Create a new instance of a Response.ResponseBuilder.

Overrides:

createResponseBuilder in class ResteasyProviderFactoryImpl

Returns:

new ResponseBuilder instance.

See Also:

• Response.ResponseBuilder

registerProviderInstance

public void registerProviderInstance(Object provider)

Description copied from class: ResteasyProviderFactoryImpl

Register a @Provider object. Can be a MessageBodyReader/Writer or ExceptionMapper.

Overrides:

registerProviderInstance in class ResteasyProviderFactoryImpl

Parameters:

provider - provider instance

createStringParameterUnmarshaller

public <T> StringParameterUnmarshaller<T> createStringParameterUnmarshaller(Class<T> clazz)

Overrides:

createStringParameterUnmarshaller in class ResteasyProviderFactoryImpl

setInjectorFactory

public void setInjectorFactory(InjectorFactory injectorFactory)

Overrides:

setInjectorFactory in class ResteasyProviderFactoryImpl

getInstances

public Set<Object> getInstances()

Description copied from interface: Configuration

Get the immutable set of registered JAX-RS component (such as provider or feature) instances to be utilized by the configurable instance. Fields and properties of returned instances are injected with their declared dependencies (see Context) by the runtime prior to use.

For each component type, there can be only a single class-based or instance-based registration present in the configuration context at any given time.

Specified by:

getInstances in interface Configuration

Overrides:

getInstances in class ResteasyProviderFactoryImpl

Returns:

the immutable set of registered JAX-RS component instances. The returned value may be empty but will never be null.

See Also:

• Configuration.getClasses()

isRegistered

public boolean isRegistered(Object component)

Description copied from interface: Configuration

Check if a particular JAX-RS component instance (such as providers or features) has been previously registered in the runtime configuration context.

Method returns true only in case an instance equal to the component instance is already present among the components previously registered in the configuration context.

Specified by:

isRegistered in interface Configuration

Overrides:

isRegistered in class ResteasyProviderFactoryImpl

Parameters:

component - a component instance to test for.

Returns:

true if the component instance has been previously registered in this configuration context, false otherwise.

See Also:

• Configuration.isEnabled(Feature)

register

public ResteasyProviderFactory register(Class<?> componentClass,
 int priority)

Description copied from interface: Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Class) except that any priority specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden with the supplied priority value.

Note that in case the priority is not applicable to a particular provider contract implemented by the class of the registered component, the supplied priority value will be ignored for that contract.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

componentClass - JAX-RS component class to be configured in the scope of this configurable context.

priority - the overriding priority for the registered component and all the provider contracts the component implements.

Returns:

the updated configurable context.

getContextResolver

public <T> ContextResolver<T> getContextResolver(Class<T> contextType,
 MediaType mediaType)

Description copied from interface: Providers

Get a context resolver for a particular type of context and media type. The set of resolvers is first filtered by comparing the supplied value of mediaType with the value of each resolver's Produces, ensuring the generic type of the context resolver is assignable to the supplied value of contextType, and eliminating those that do not match. If only one resolver matches the criteria then it is returned. If more than one resolver matches then the list of matching resolvers is ordered with those with the best matching values of Produces (x/y > x/* > */*) sorted first. A proxy is returned that delegates calls to ContextResolver.getContext(java.lang.Class) to each matching context resolver in order and returns the first non-null value it obtains or null if all matching context resolvers return null.

Specified by:

getContextResolver in interface Providers

Overrides:

getContextResolver in class ResteasyProviderFactoryImpl

Type Parameters:

T - type of the context.

Parameters:

contextType - the class of context desired.

mediaType - the media type of data for which a context is required.

Returns:

a matching context resolver instance or null if no matching context providers are found.

getMessageBodyReader

public <T> MessageBodyReader<T> getMessageBodyReader(Class<T> type,
 Type genericType,
 Annotation[] annotations,
 MediaType mediaType)

Description copied from class: ResteasyProviderFactoryImpl

Always returns server MBRs.

Specified by:

getMessageBodyReader in interface Providers

Overrides:

getMessageBodyReader in class ResteasyProviderFactoryImpl

Type Parameters:

T - type

Parameters:

type - the class of the object that is to be read.

genericType - the type of object to be produced. E.g. if the message body is to be converted into a method parameter, this will be the formal type of the method parameter as returned by Class.getGenericParameterTypes.

annotations - an array of the annotations on the declaration of the artifact that will be initialized with the produced instance. E.g. if the message body is to be converted into a method parameter, this will be the annotations on that parameter returned by Class.getParameterAnnotations.

mediaType - the media type of the data that will be read.

Returns:

message reader

registerProvider

public void registerProvider(Class provider,
 Integer priorityOverride,
 boolean isBuiltin,
 Map<Class<?>,Integer> contracts)

Overrides:

registerProvider in class ResteasyProviderFactoryImpl

getContainerRequestFilterRegistry

public JaxrsInterceptorRegistry<ContainerRequestFilter> getContainerRequestFilterRegistry()

Overrides:

getContainerRequestFilterRegistry in class ResteasyProviderFactoryImpl

register

public ResteasyProviderFactory register(Object component,
 Map<Class<?>,Integer> contracts)

Description copied from interface: Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides same functionality as Configurable.register(Object, Class[]) except that any priority specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden for each extension provider contract type separately with an integer priority value specified as a value in the supplied map of [contract type, priority] pairs.

Note that in case a priority is not applicable to a provider contract registered for the JAX-RS component, the supplied priority value is ignored for such contract.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

component - JAX-RS component instance to be configured in the scope of this configurable context.

contracts - map of the specific extension provider and meta-provider contracts and their associated priorities for which the JAX-RS component is registered. All contracts in the map must represent a class or an interface implemented or extended by the JAX-RS component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Returns:

the updated configurable context.

isRegisterBuiltins

public boolean isRegisterBuiltins()

Overrides:

isRegisterBuiltins in class ResteasyProviderFactoryImpl

getClientReaderInterceptorRegistry

public JaxrsInterceptorRegistry<ReaderInterceptor> getClientReaderInterceptorRegistry()

Overrides:

getClientReaderInterceptorRegistry in class ResteasyProviderFactoryImpl

setRegisterBuiltins

public void setRegisterBuiltins(boolean registerBuiltins)

Overrides:

setRegisterBuiltins in class ResteasyProviderFactoryImpl

register

public ResteasyProviderFactory register(Object component,
 int priority)

Description copied from interface: Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Object) except that any priority specified on the registered JAX-RS component class via jakarta.annotation.Priority annotation is overridden with the supplied priority value.

Note that in case the priority is not applicable to a particular provider contract implemented by the class of the registered component, the supplied priority value will be ignored for that contract.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

component - JAX-RS component instance to be configured in the scope of this configurable context.

priority - the overriding priority for the registered component and all the provider contracts the component implements.

Returns:

the updated configurable context.

registerProvider

public void registerProvider(Class provider,
 boolean isBuiltin)

Description copied from class: ResteasyProviderFactoryImpl

Register a @Provider class. Can be a MessageBodyReader/Writer or ExceptionMapper.

Overrides:

registerProvider in class ResteasyProviderFactoryImpl

Parameters:

provider - provider class

isBuiltin - built-in

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: Configuration

Returns an immutable collection containing the property names available within the context of the current configuration instance.

Use the Configuration.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

getPropertyNames in interface Configuration

Overrides:

getPropertyNames in class ResteasyProviderFactoryImpl

Returns:

an immutable collection of property names.

See Also:

• Configuration.getProperty(java.lang.String)

register

public ResteasyProviderFactory register(Object provider)

Description copied from interface: Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context. Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS component types in the given configurable context. Any subsequent registration attempts for a component type, for which a class or instance-based registration already exists in the system MUST be rejected by the JAX-RS implementation and a warning SHOULD be raised to inform the user about the rejected registration. The registered JAX-RS component is registered as a contract provider of all the recognized JAX-RS or implementation-specific extension contracts including meta-provider contracts, such as Feature or DynamicFeature.

As opposed to components registered via Configurable.register(Class) method, the lifecycle of providers registered using this instance-based register(...) is not managed by JAX-RS runtime. The same registered component instance is used during the whole lifespan of the configurable context. Fields and properties of all registered JAX-RS component instances are injected with their declared dependencies (see Context) by the JAX-RS runtime prior to use.

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

provider - JAX-RS component instance to be configured in the scope of this configurable context.

Returns:

the updated configurable context.

createProviderInstance

public <T> T createProviderInstance(Class<? extends T> clazz)

Description copied from class: ResteasyProviderFactoryImpl

Create an instance of a class using provider allocation rules of the specification as well as the InjectorFactory only does constructor injection.

Overrides:

createProviderInstance in class ResteasyProviderFactoryImpl

Type Parameters:

T - type

Parameters:

clazz - class

Returns:

provider instance of type T

isRegistered

public boolean isRegistered(Class<?> componentClass)

Description copied from interface: Configuration

Check if a JAX-RS component of the supplied componentClass class has been previously registered in the runtime configuration context.

Method returns true in case a component of the supplied componentClass class is already present among the previously registered component classes or instances in the configuration context.

Specified by:

isRegistered in interface Configuration

Overrides:

isRegistered in class ResteasyProviderFactoryImpl

Parameters:

componentClass - a component class to test for.

Returns:

true if a component of a given class has been previously registered in this configuration context, false otherwise.

See Also:

• Configuration.isEnabled(Class)

createEndpoint

public <T> T createEndpoint(Application applicationConfig,
 Class<T> endpointType)
                     throws IllegalArgumentException,
UnsupportedOperationException

Description copied from class: ResteasyProviderFactoryImpl

This is a spec method that is unsupported. It is an optional method anyways.

Overrides:

createEndpoint in class ResteasyProviderFactoryImpl

Type Parameters:

T - endpoint type.

Parameters:

applicationConfig - application

endpointType - endpoint type

Returns:

endpoint

Throws:

IllegalArgumentException - if applicationConfig is null

UnsupportedOperationException - allways throw since this method is not supported

getMutableProperties

public Map<String,Object> getMutableProperties()

Overrides:

getMutableProperties in class ResteasyProviderFactoryImpl

getServerDynamicFeatures

public Set<DynamicFeature> getServerDynamicFeatures()

Overrides:

getServerDynamicFeatures in class ResteasyProviderFactoryImpl

isEnabled

public boolean isEnabled(Feature feature)

Description copied from interface: Configuration

Check if a particular feature instance has been previously enabled in the runtime configuration context.

Method returns true only in case an instance equal to the feature instance is already present among the features previously successfully enabled in the configuration context.

Specified by:

isEnabled in interface Configuration

Overrides:

isEnabled in class ResteasyProviderFactoryImpl

Parameters:

feature - a feature instance to test for.

Returns:

true if the feature instance has been previously enabled in this configuration context, false otherwise.

getProperty

public Object getProperty(String name)

Description copied from interface: Configuration

Get the value for the property with a given name.

Specified by:

getProperty in interface Configuration

Overrides:

getProperty in class ResteasyProviderFactoryImpl

Parameters:

name - property name.

Returns:

the property value for the specified property name or null if the property with such name is not configured.

getServerWriterInterceptorRegistry

public JaxrsInterceptorRegistry<WriterInterceptor> getServerWriterInterceptorRegistry()

Overrides:

getServerWriterInterceptorRegistry in class ResteasyProviderFactoryImpl

setProperties

public ResteasyProviderFactory setProperties(Map<String,Object> properties)

Overrides:

setProperties in class ResteasyProviderFactoryImpl

createUriBuilder

public UriBuilder createUriBuilder()

Description copied from class: RuntimeDelegate

Create a new instance of a UriBuilder.

Overrides:

createUriBuilder in class ResteasyProviderFactoryImpl

Returns:

new UriBuilder instance.

See Also:

• UriBuilder

register

public ResteasyProviderFactory register(Class<?> componentClass,
 Class<?>... contracts)

Description copied from interface: Configurable

Register a class of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Class) except the JAX-RS component class is only registered as a provider of the listed extension provider or meta-provider contracts. All explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

componentClass - JAX-RS component class to be configured in the scope of this configurable context.

contracts - the specific extension provider or meta-provider contracts implemented by the component for which the component should be registered. Implementations MUST ignore attempts to register a component class for an empty or null collection of contracts via this method and SHOULD raise a warning about such event.

Returns:

the updated configurable context.

injectedInstance

public <T> T injectedInstance(Class<? extends T> clazz)

Description copied from class: ResteasyProviderFactoryImpl

Property and constructor injection using the InjectorFactory.

Overrides:

injectedInstance in class ResteasyProviderFactoryImpl

Type Parameters:

T - type

Parameters:

clazz - class

Returns:

instance of type T

getRuntimeType

public RuntimeType getRuntimeType()

Description copied from interface: Configuration

Get the runtime type of this configuration context.

Specified by:

getRuntimeType in interface Configuration

Overrides:

getRuntimeType in class ResteasyProviderFactoryImpl

Returns:

configuration context runtime type.

injectProperties

public void injectProperties(Object obj)

Overrides:

injectProperties in class ResteasyProviderFactoryImpl

property

public ResteasyProviderFactory property(String name,
 Object value)

Description copied from interface: Configurable

Set the new configuration property, if already set, the existing value of the property will be updated. Setting a null value into a property effectively removes the property from the property bag.

Specified by:

property in interface Configurable<ResteasyProviderFactory>

Overrides:

property in class ResteasyProviderFactoryImpl

Parameters:

name - property name.

value - (new) property value. null value removes the property with the given name.

Returns:

the updated configurable instance.

getClientWriterInterceptorRegistry

public JaxrsInterceptorRegistry<WriterInterceptor> getClientWriterInterceptorRegistry()

Overrides:

getClientWriterInterceptorRegistry in class ResteasyProviderFactoryImpl

getInjectorFactory

public InjectorFactory getInjectorFactory()

Overrides:

getInjectorFactory in class ResteasyProviderFactoryImpl

getContracts

public Map<Class<?>,Integer> getContracts(Class<?> componentClass)

Description copied from interface: Configuration

Get the extension contract registration information for a component of a given class. For component classes that are not configured in this configuration context the method returns an empty Map. Method does not return null.

Specified by:

getContracts in interface Configuration

Overrides:

getContracts in class ResteasyProviderFactoryImpl

Parameters:

componentClass - a component class for which to get contracts.

Returns:

map of extension contracts and their priorities for which the component class is registered. May return an empty map in case the component has not been registered for any extension contract supported by the implementation.

getParamConverter

public ParamConverter getParamConverter(Class clazz,
 Type genericType,
 Annotation[] annotations)

Overrides:

getParamConverter in class ResteasyProviderFactoryImpl

getClientResponseFilters

public JaxrsInterceptorRegistry<ClientResponseFilter> getClientResponseFilters()

Overrides:

getClientResponseFilters in class ResteasyProviderFactoryImpl

register

public ResteasyProviderFactory register(Object component,
 Class<?>... contracts)

Description copied from interface: Configurable

Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this configurable context.

This registration method provides the same functionality as Configurable.register(Object) except the JAX-RS component class is only registered as a provider of the listed extension provider or meta-provider contracts. All explicitly enumerated contract types must represent a class or an interface implemented or extended by the registered component. Contracts that are not assignable from the registered component class MUST be ignored and implementations SHOULD raise a warning to inform users about the ignored contract(s).

Specified by:

register in interface Configurable<ResteasyProviderFactory>

Overrides:

register in class ResteasyProviderFactoryImpl

Parameters:

component - JAX-RS component instance to be configured in the scope of this configurable context.

contracts - the specific extension provider or meta-provider contracts implemented by the component for which the component should be registered. Implementations MUST ignore attempts to register a component class for an empty or null collection of contracts via this method and SHOULD raise a warning about such event.

Returns:

the updated configurable context.

getClasses

public Set<Class<?>> getClasses()

Description copied from interface: Configuration

Get the immutable set of registered JAX-RS component (such as provider, root resource or feature) classes to be instantiated, injected and utilized in the scope of the configurable instance. In contrast to Application.getClasses() this method returns a complete runtime view and therefore also includes auto-discovered components.

For each component type, there can be only a single class-based or instance-based registration present in the configuration context at any given time.

Specified by:

getClasses in interface Configuration

Overrides:

getClasses in class ResteasyProviderFactoryImpl

Returns:

the immutable set of registered JAX-RS component classes. The returned value may be empty but will never be null.

See Also:

• Configuration.getInstances()

isEnabled

public boolean isEnabled(Class<? extends Feature> featureClass)

Description copied from interface: Configuration

Check if a feature instance of featureClass class has been previously enabled in the runtime configuration context.

Method returns true in case any instance of the featureClass class is already present among the features previously successfully enabled in the configuration context.

Specified by:

isEnabled in interface Configuration

Overrides:

isEnabled in class ResteasyProviderFactoryImpl

Parameters:

featureClass - a feature class to test for.

Returns:

true if a feature of a given class has been previously enabled in this configuration context, false otherwise.

registerProvider

public void registerProvider(Class provider)

Overrides:

registerProvider in class ResteasyProviderFactoryImpl

addHeaderDelegate

public void addHeaderDelegate(Class clazz,
 RuntimeDelegate.HeaderDelegate header)

Overrides:

addHeaderDelegate in class ResteasyProviderFactoryImpl

registerProviderInstance

public void registerProviderInstance(Object provider,
 Map<Class<?>,Integer> contracts,
 Integer defaultPriority,
 boolean builtIn)

Overrides:

registerProviderInstance in class ResteasyProviderFactoryImpl

getProviderClasses

public Set<Class<?>> getProviderClasses()

Description copied from class: ResteasyProviderFactoryImpl

Gets provide classes.

Overrides:

getProviderClasses in class ResteasyProviderFactoryImpl

Returns:

set of provider classes

toString

public String toString(Object object,
 Class clazz,
 Type genericType,
 Annotation[] annotations)

Description copied from class: ResteasyProviderFactoryImpl

Convert an object to a string. First try StringConverter then, object.ToString()

Overrides:

toString in class ResteasyProviderFactoryImpl

Parameters:

object - object

clazz - class

genericType - generic type

annotations - array of annotation

Returns:

string representation

getClientRequestFilterRegistry

public JaxrsInterceptorRegistry<ClientRequestFilter> getClientRequestFilterRegistry()

Overrides:

getClientRequestFilterRegistry in class ResteasyProviderFactoryImpl

getProperties

public Map<String,Object> getProperties()

Description copied from interface: Configuration

Get the immutable bag of configuration properties.

Specified by:

getProperties in interface Configuration

Overrides:

getProperties in class ResteasyProviderFactoryImpl

Returns:

the immutable view of configuration properties.

toHeaderString

public String toHeaderString(Object object)

Description copied from interface: HeaderValueProcessor

Convert an object to a header string. First try StringConverter, then HeaderDelegate, then object.toString().

Specified by:

toHeaderString in interface HeaderValueProcessor

Overrides:

toHeaderString in class ResteasyProviderFactoryImpl

Parameters:

object - header object

Returns:

header string representation

createLinkBuilder

public Link.Builder createLinkBuilder()

Description copied from class: RuntimeDelegate

Create a new instance of a Link.Builder.

Overrides:

createLinkBuilder in class ResteasyProviderFactoryImpl

Returns:

new Link.Builder instance.

See Also:

• Link.Builder

getProviderInstances

public Set<Object> getProviderInstances()

Description copied from class: ResteasyProviderFactoryImpl

Gets provider instances.

Overrides:

getProviderInstances in class ResteasyProviderFactoryImpl

Returns:

set of provider instances

getConfiguration

public Configuration getConfiguration()

Description copied from interface: Configurable

Get a live view of an internal configuration state of this configurable instance. Any changes made using methods of this Configurable instance will be reflected in the returned Configuration instance.

The returned Configuration instance and the collection data it provides are not thread-safe wrt. modification made using methods on the parent configurable object.

Specified by:

getConfiguration in interface Configurable<ResteasyProviderFactory>

Overrides:

getConfiguration in class ResteasyProviderFactoryImpl

Returns:

configuration live view of the internal configuration state.

getMessageBodyWriter

public <T> MessageBodyWriter<T> getMessageBodyWriter(Class<T> type,
 Type genericType,
 Annotation[] annotations,
 MediaType mediaType)

Description copied from class: ResteasyProviderFactoryImpl

Always gets server MBW.

Specified by:

getMessageBodyWriter in interface Providers

Overrides:

getMessageBodyWriter in class ResteasyProviderFactoryImpl

Type Parameters:

T - type

Parameters:

type - the class of the object that is to be written.

genericType - the type of object to be written. E.g. if the message body is to be produced from a field, this will be the declared type of the field as returned by Field.getGenericType.

annotations - an array of the annotations on the declaration of the artifact that will be written. E.g. if the message body is to be produced from a field, this will be the annotations on that field returned by Field.getDeclaredAnnotations.

mediaType - the media type of the data that will be written.

Returns:

message writer

getExceptionMapper

public <T extends Throwable> ExceptionMapper<T> getExceptionMapper(Class<T> type)

Description copied from interface: Providers

Get an exception mapping provider for a particular class of exception. Returns the provider whose generic type is the nearest superclass of type.

Specified by:

getExceptionMapper in interface Providers

Overrides:

getExceptionMapper in class ResteasyProviderFactoryImpl

Type Parameters:

T - type of the exception handled by the exception mapping provider.

Parameters:

type - the class of exception.

Returns:

an ExceptionMapper for the supplied type or null if none is found.

getAsyncResponseProvider

public <T> AsyncResponseProvider<T> getAsyncResponseProvider(Class<T> type)

Overrides:

getAsyncResponseProvider in class ResteasyProviderFactoryImpl

getAsyncResponseProviders

public Map<Class<?>,AsyncResponseProvider> getAsyncResponseProviders()

Overrides:

getAsyncResponseProviders in class ResteasyProviderFactoryImpl

getAsyncStreamProvider

public <T> AsyncStreamProvider<T> getAsyncStreamProvider(Class<T> type)

Overrides:

getAsyncStreamProvider in class ResteasyProviderFactoryImpl

getAsyncStreamProviders

public Map<Class<?>,AsyncStreamProvider> getAsyncStreamProviders()

Overrides:

getAsyncStreamProviders in class ResteasyProviderFactoryImpl

createHeaderDelegate

public <T> RuntimeDelegate.HeaderDelegate<T> createHeaderDelegate(Class<T> tClass)

Description copied from class: RuntimeDelegate

Obtain an instance of a RuntimeDelegate.HeaderDelegate for the supplied class. An implementation is required to support the following values for type: CacheControl, Cookie, EntityTag, Link, NewCookie, MediaType and java.util.Date.

Overrides:

createHeaderDelegate in class ResteasyProviderFactoryImpl

Type Parameters:

T - header type.

Parameters:

tClass - the class of the header.

Returns:

an instance of HeaderDelegate for the supplied type.

See Also:

• RuntimeDelegate.HeaderDelegate

getContextData

public <T> T getContextData(Class<T> rawType,
 Type genericType,
 Annotation[] annotations,
 boolean unwrapAsync)

Overrides:

getContextData in class ResteasyProviderFactoryImpl

getContextInjectors

public Map<Type,ContextInjector> getContextInjectors()

Overrides:

getContextInjectors in class ResteasyProviderFactoryImpl

getAsyncContextInjectors

public Map<Type,ContextInjector> getAsyncContextInjectors()

Overrides:

getAsyncContextInjectors in class ResteasyProviderFactoryImpl

getClientMessageBodyWriter

public <T> MessageBodyWriter<T> getClientMessageBodyWriter(Class<T> type,
 Type genericType,
 Annotation[] annotations,
 MediaType mediaType)

Overrides:

getClientMessageBodyWriter in class ResteasyProviderFactoryImpl

getClientMessageBodyReader

public <T> MessageBodyReader<T> getClientMessageBodyReader(Class<T> type,
 Type genericType,
 Annotation[] annotations,
 MediaType mediaType)

Overrides:

getClientMessageBodyReader in class ResteasyProviderFactoryImpl

getThrowableExceptionMapper

public ExceptionMapper<Throwable> getThrowableExceptionMapper()

Description copied from class: ResteasyProviderFactory

Returns an exception mapper which handles the generic throwable which is typically the default exception mapper.

Overrides:

getThrowableExceptionMapper in class ResteasyProviderFactoryImpl

Returns:

an exception mapper which handles a Throwable