public interface Configurable<C extends Configurable>
Configurable context are reflected in the associated
Configuration state which is exposed via getConfiguration() method.
A configurable context can be either indirectly associated with a particular JAX-RS component
(such as application or resource method configurable context passed to a Feature
or DynamicFeature meta-providers) or can be directly represented
by a concrete JAX-RS component implementing the Configurable interface
(such as Client or WebTarget).
As such, the exact scope of a configuration context is typically determined by a use case
scenario in which the context is accessed.
New properties can be set using the property(java.lang.String, java.lang.Object) method. Similarly, updating a value of
an existing property can be achieved using the same method. Information about the configured set of
properties is available via the underlying Configuration object. An existing property
can be removed by assigning a null value to the property.
Registered custom JAX-RS component classes and instances are important part of the contextual configuration information as these are the main factors that determine the capabilities of a configured runtime. Implementations SHOULD warn about and ignore registrations that do not conform to the requirements of supported JAX-RS components in a given configurable context.
In most cases, when registering a JAX-RS component, the simplest form of methods
(register(Class) or register(Object)) of the available registration API
is sufficient.
For example:
config.register(HtmlDocumentReader.class); config.register(new HtmlDocumentWriter(writerConfig));
In some situations a JAX-RS component class or instance may implement multiple provider contracts recognized by a JAX-RS implementation (e.g. filter, interceptor or entity provider). By default, the JAX-RS implementation MUST register the new component class or instance as a provider for all the recognized provider contracts implemented by the component class.
For example:
@Priority(ENTITY_CODER)
public class GzipInterceptor
implements ReaderInterceptor, WriterInterceptor { ... }
...
// register GzipInterceptor as a ReaderInterceptor
// as well as a WriterInterceptor
config.register(GzipInterceptor.class);
There are however situations when the default registration of a JAX-RS component to all the
recognized provider contracts is not desirable. In such cases users may use other versions of the
register(...) method to explicitly specify the collection of the provider contracts
for which the JAX-RS component should be registered and/or the priority of each registered
provider contract.
For example:
@Priority(USER)
public class ClientLoggingFilter
implements ClientRequestFilter, ClientResponseFilter { ... }
@Priority(ENTITY_CODER)
public class GzipInterceptor
implements ReaderInterceptor, WriterInterceptor { ... }
...
// register ClientLoggingFilter as a ClientResponseFilter only
config.register(ClientLoggingFilter.class, ClientResponseFilter.class);
// override the priority of registered GzipInterceptor
// and both of it's provider contracts
config.register(GzipInterceptor.class, 6500);
As a general rule, for each JAX-RS component class there can be at most one registration — class-based or instance-based — configured at any given moment. Implementations MUST reject any attempts to configure a new registration for a provider class that has been already registered in the given configurable context earlier. Implementations SHOULD also raise a warning to inform the user about the rejected component registration.
For example:
config.register(GzipInterceptor.class, WriterInterceptor.class);
config.register(GzipInterceptor.class); // Rejected by runtime.
config.register(new GzipInterceptor()); // Rejected by runtime.
config.register(GzipInterceptor.class, 6500); // Rejected by runtime.
config.register(new ClientLoggingFilter());
config.register(ClientLoggingFilter.class); // rejected by runtime.
config.register(ClientLoggingFilter.class,
ClientResponseFilter.class); // Rejected by runtime.
| Modifier and Type | Method and Description |
|---|---|
Configuration |
getConfiguration()
Get a live view of an internal configuration state of this configurable instance.
|
C |
property(String name,
Object value)
Set the new configuration property, if already set, the existing value of
the property will be updated.
|
C |
register(Class<?> componentClass)
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. |
C |
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. |
C |
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. |
C |
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. |
C |
register(Object component)
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. |
C |
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. |
C |
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. |
C |
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. |
Configuration getConfiguration()
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.
C property(String name, Object value)
null value into a property
effectively removes the property from the property bag.name - property name.value - (new) property value. null value removes the property
with the given name.C register(Class<?> componentClass)
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 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.
componentClass - JAX-RS component class to be configured in the scope of this
configurable context.C register(Class<?> componentClass, int priority)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides the same functionality as register(Class)
except that any priority specified on the registered JAX-RS component class via
javax.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.
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.C register(Class<?> componentClass, Class<?>... contracts)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides the same functionality as 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).
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.C register(Class<?> componentClass, Map<Class<?>,Integer> contracts)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides same functionality as register(Class, Class[])
except that any priority specified on the registered JAX-RS component class via
javax.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.
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).C register(Object component)
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 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.
component - JAX-RS component instance to be configured in the scope of this
configurable context.C register(Object component, int priority)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides the same functionality as register(Object)
except that any priority specified on the registered JAX-RS component class via
javax.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.
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.C register(Object component, Class<?>... contracts)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides the same functionality as 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).
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.C register(Object component, Map<Class<?>,Integer> contracts)
feature meta-provider) to be instantiated
and used in the scope of this configurable context.
This registration method provides same functionality as register(Object, Class[])
except that any priority specified on the registered JAX-RS component class via
javax.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.
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).Copyright © 1996-2015, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.