org.glassfish.jersey.model.internal

Class CommonConfig

java.lang.Object

org.glassfish.jersey.model.internal.CommonConfig

All Implemented Interfaces:

javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>, javax.ws.rs.core.Configuration, javax.ws.rs.core.FeatureContext, ExtendedConfig

Direct Known Subclasses:

ImmutableCommonConfig, ResourceConfig.State, ResourceMethodConfig

public class CommonConfig
extends java.lang.Object
implements javax.ws.rs.core.FeatureContext, ExtendedConfig

Common immutable Configuration implementation for server and client.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	CommonConfig.FeatureRegistration A single feature registration record.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.common.base.Function<java.lang.Object,org.glassfish.hk2.utilities.Binder>	CAST_TO_BINDER
private ComponentBag	componentBag Configured providers, does not include features and binders.
private boolean	disableMetaProviderConfiguration Flag determining whether the configuration of meta-providers (excl.
private java.util.Set<java.lang.Class<? extends javax.ws.rs.core.Feature>>	enabledFeatureClasses Collection of enabled feature classes.
private java.util.Set<javax.ws.rs.core.Feature>	enabledFeatures Collection of enabled feature instances.
private java.util.Map<java.lang.String,java.lang.Object>	immutablePropertiesView
private java.util.Collection<java.lang.String>	immutablePropertyNames
private static java.util.logging.Logger	LOGGER
private java.util.List<CommonConfig.FeatureRegistration>	newFeatureRegistrations Collection of unprocessed feature registrations.
private java.util.Map<java.lang.String,java.lang.Object>	properties Configuration properties collection and it's immutable views.
private javax.ws.rs.RuntimeType	type Configuration runtime type.

Constructor Summary

Constructors

Constructor and Description
CommonConfig(CommonConfig config) Copy constructor.
CommonConfig(javax.ws.rs.RuntimeType type, com.google.common.base.Predicate<ContractProvider> registrationStrategy) Create a new RuntimeConfig instance.

Method Summary

Modifier and Type	Method and Description
CommonConfig	addProperties(java.util.Map<java.lang.String,?> properties) Add properties to ResourceConfig.
private java.util.Set<java.lang.Class<?>>	asNewIdentitySet(java.lang.Class<?>... contracts)
private void	checkComponentClassNotNull(java.lang.Class<?> componentClass)
private void	checkProviderNotNull(java.lang.Object provider)
void	configureAutoDiscoverableProviders(org.glassfish.hk2.api.ServiceLocator locator, boolean forcedOnly) Configure auto-discoverables in the HK2 service locator.
private java.util.Set<org.glassfish.hk2.utilities.Binder>	configureBinders(org.glassfish.hk2.api.ServiceLocator locator, java.util.Set<org.glassfish.hk2.utilities.Binder> configured)
private void	configureFeatures(org.glassfish.hk2.api.ServiceLocator locator, java.util.Set<CommonConfig.FeatureRegistration> processed, java.util.List<CommonConfig.FeatureRegistration> unprocessed)
void	configureMetaProviders(org.glassfish.hk2.api.ServiceLocator locator) Configure HK2 binders in the HK2 service locator and enable JAX-RS features.
private void	copy(CommonConfig config, boolean loadComponentBag) Copy config properties, providers from given config to this instance.
boolean	equals(java.lang.Object o)
private java.util.Collection<org.glassfish.hk2.utilities.Binder>	getBinders(java.util.Set<org.glassfish.hk2.utilities.Binder> configured)
java.util.Set<java.lang.Class<?>>	getClasses()
ComponentBag	getComponentBag() Returns a ComponentBag instance associated with the configuration.
ExtendedConfig	getConfiguration()
java.util.Map<java.lang.Class<?>,java.lang.Integer>	getContracts(java.lang.Class<?> componentClass)
java.util.Set<java.lang.Object>	getInstances()
protected Inflector<ContractProvider.Builder,ContractProvider>	getModelEnhancer(java.lang.Class<?> componentClass) An extension point that provides a way how to define a custom enhancement/update operation of a contract provider model registration being produced for a given component class.
java.util.Map<java.lang.String,java.lang.Object>	getProperties()
java.lang.Object	getProperty(java.lang.String name)
java.util.Collection<java.lang.String>	getPropertyNames()
javax.ws.rs.RuntimeType	getRuntimeType()
int	hashCode()
boolean	isEnabled(java.lang.Class<? extends javax.ws.rs.core.Feature> featureClass)
boolean	isEnabled(javax.ws.rs.core.Feature feature)
boolean	isProperty(java.lang.String name) Get the value of the property with a given name converted to boolean.
boolean	isRegistered(java.lang.Class<?> componentClass)
boolean	isRegistered(java.lang.Object component)
CommonConfig	loadFrom(javax.ws.rs.core.Configuration config) Load the internal configuration state from an externally provided configuration state.
private void	processFeatureRegistration(java.lang.Object component, java.lang.Class<?> componentClass)
CommonConfig	property(java.lang.String name, java.lang.Object value)
CommonConfig	register(java.lang.Class<?> componentClass)
CommonConfig	register(java.lang.Class<?> componentClass, java.lang.Class<?>... contracts)
CommonConfig	register(java.lang.Class<?> componentClass, int bindingPriority)
CommonConfig	register(java.lang.Class<?> componentClass, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
CommonConfig	register(java.lang.Object component)
CommonConfig	register(java.lang.Object component, java.lang.Class<?>... contracts)
CommonConfig	register(java.lang.Object component, int bindingPriority)
CommonConfig	register(java.lang.Object component, java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)
private void	registerManagedObjectsFinalizer(org.glassfish.hk2.api.ServiceLocator locator)
private java.util.List<CommonConfig.FeatureRegistration>	resetRegistrations()
CommonConfig	setProperties(java.util.Map<java.lang.String,?> properties) Set the configured properties to the provided map of properties.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final java.util.logging.Logger LOGGER

CAST_TO_BINDER

private static final com.google.common.base.Function<java.lang.Object,org.glassfish.hk2.utilities.Binder> CAST_TO_BINDER

type

private final javax.ws.rs.RuntimeType type

Configuration runtime type.

properties

private final java.util.Map<java.lang.String,java.lang.Object> properties

Configuration properties collection and it's immutable views.

immutablePropertiesView

private final java.util.Map<java.lang.String,java.lang.Object> immutablePropertiesView

immutablePropertyNames

private final java.util.Collection<java.lang.String> immutablePropertyNames

componentBag

private final ComponentBag componentBag

Configured providers, does not include features and binders.

newFeatureRegistrations

private final java.util.List<CommonConfig.FeatureRegistration> newFeatureRegistrations

Collection of unprocessed feature registrations.

enabledFeatureClasses

private final java.util.Set<java.lang.Class<? extends javax.ws.rs.core.Feature>> enabledFeatureClasses

Collection of enabled feature classes.

enabledFeatures

private final java.util.Set<javax.ws.rs.core.Feature> enabledFeatures

Collection of enabled feature instances.

disableMetaProviderConfiguration

private boolean disableMetaProviderConfiguration

Flag determining whether the configuration of meta-providers (excl. binders) should be disabled.

Constructor Detail

CommonConfig

public CommonConfig(javax.ws.rs.RuntimeType type,
                    com.google.common.base.Predicate<ContractProvider> registrationStrategy)

Create a new RuntimeConfig instance.

The constructor provides a way for defining a contract provider model registration strategy. Once a registration model is built for a newly registered contract, the provided registration strategy filter is consulted whether the model should be registered or not.

Clients can use the method to cancel any contract provider model registration that does not meet the criteria of a given configuration context, such as a model that does not have any recognized contracts associated with it.

Parameters:

type - configuration runtime type.

registrationStrategy - function driving the decision (based on the introspected contract provider model) whether or not should the component class registration continue towards a successful completion.

CommonConfig

public CommonConfig(CommonConfig config)

Copy constructor.

Parameters:

config - configurable to copy class properties from.

Method Detail

copy

private void copy(CommonConfig config,
                  boolean loadComponentBag)

Copy config properties, providers from given config to this instance.

Parameters:

config - configurable to copy class properties from.

loadComponentBag - true if the component bag from config should be copied as well, false otherwise.

getConfiguration

public ExtendedConfig getConfiguration()

Specified by:

getConfiguration in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

getRuntimeType

public javax.ws.rs.RuntimeType getRuntimeType()

Specified by:

getRuntimeType in interface javax.ws.rs.core.Configuration

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Specified by:

getProperties in interface javax.ws.rs.core.Configuration

getProperty

public java.lang.Object getProperty(java.lang.String name)

Specified by:

getProperty in interface javax.ws.rs.core.Configuration

isProperty

public boolean isProperty(java.lang.String name)

Description copied from interface: ExtendedConfig

Get the value of the property with a given name converted to boolean. Returns false if the value is not convertible.

Specified by:

isProperty in interface ExtendedConfig

Parameters:

name - property name.

Returns:

boolean property value or false if the property is not convertible.

getPropertyNames

public java.util.Collection<java.lang.String> getPropertyNames()

Specified by:

getPropertyNames in interface javax.ws.rs.core.Configuration

isEnabled

public boolean isEnabled(java.lang.Class<? extends javax.ws.rs.core.Feature> featureClass)

Specified by:

isEnabled in interface javax.ws.rs.core.Configuration

isEnabled

public boolean isEnabled(javax.ws.rs.core.Feature feature)

Specified by:

isEnabled in interface javax.ws.rs.core.Configuration

isRegistered

public boolean isRegistered(java.lang.Object component)

Specified by:

isRegistered in interface javax.ws.rs.core.Configuration

isRegistered

public boolean isRegistered(java.lang.Class<?> componentClass)

Specified by:

isRegistered in interface javax.ws.rs.core.Configuration

getContracts

public java.util.Map<java.lang.Class<?>,java.lang.Integer> getContracts(java.lang.Class<?> componentClass)

Specified by:

getContracts in interface javax.ws.rs.core.Configuration

getClasses

public java.util.Set<java.lang.Class<?>> getClasses()

Specified by:

getClasses in interface javax.ws.rs.core.Configuration

getInstances

public java.util.Set<java.lang.Object> getInstances()

Specified by:

getInstances in interface javax.ws.rs.core.Configuration

getComponentBag

public final ComponentBag getComponentBag()

Returns a ComponentBag instance associated with the configuration.

Returns:

a non-null component bag instance.

getModelEnhancer

protected Inflector<ContractProvider.Builder,ContractProvider> getModelEnhancer(java.lang.Class<?> componentClass)

An extension point that provides a way how to define a custom enhancement/update operation of a contract provider model registration being produced for a given component class. Default implementation return an enhancer just builds the model.

Derived implementations may use this method to e.g. filter out all contracts not applicable in the given configuration context or change the model scope. The returned set of filtered contracts is then used for the actual provider registration.

Parameters:

componentClass - class of the component being registered.

Returns:

filter for the contracts that being registered for a given component class.

setProperties

public CommonConfig setProperties(java.util.Map<java.lang.String,?> properties)

Set the configured properties to the provided map of properties.

Parameters:

properties - new map of properties to be set.

Returns:

updated configuration instance.

addProperties

public CommonConfig addProperties(java.util.Map<java.lang.String,?> properties)

Add properties to ResourceConfig. If any of the added properties exists already, he values of the existing properties will be replaced with new values.

Parameters:

properties - properties to add.

Returns:

updated configuration instance.

property

public CommonConfig property(java.lang.String name,
                             java.lang.Object value)

Specified by:

property in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Class<?> componentClass)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Class<?> componentClass,
                             int bindingPriority)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Class<?> componentClass,
                             java.lang.Class<?>... contracts)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Class<?> componentClass,
                             java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Object component)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Object component,
                             int bindingPriority)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Object component,
                             java.lang.Class<?>... contracts)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

register

public CommonConfig register(java.lang.Object component,
                             java.util.Map<java.lang.Class<?>,java.lang.Integer> contracts)

Specified by:

register in interface javax.ws.rs.core.Configurable<javax.ws.rs.core.FeatureContext>

processFeatureRegistration

private void processFeatureRegistration(java.lang.Object component,
                                        java.lang.Class<?> componentClass)

loadFrom

public CommonConfig loadFrom(javax.ws.rs.core.Configuration config)

Load the internal configuration state from an externally provided configuration state.

Calling this method effectively replaces existing configuration state of the instance with the state represented by the externally provided configuration. If the features, auto-discoverables of given config has been already configured then this method will make sure to not configure them for the second time.

Parameters:

config - external configuration state to replace the configuration of this configurable instance.

Returns:

the updated common configuration instance.

asNewIdentitySet

private java.util.Set<java.lang.Class<?>> asNewIdentitySet(java.lang.Class<?>... contracts)

checkProviderNotNull

private void checkProviderNotNull(java.lang.Object provider)

checkComponentClassNotNull

private void checkComponentClassNotNull(java.lang.Class<?> componentClass)

configureAutoDiscoverableProviders

public void configureAutoDiscoverableProviders(org.glassfish.hk2.api.ServiceLocator locator,
                                               boolean forcedOnly)

Configure auto-discoverables in the HK2 service locator.

Parameters:

locator - locator in which the auto-discoverables should be configured.

forcedOnly - defines whether all or only forced auto-discoverables should be configured.

configureMetaProviders

public void configureMetaProviders(org.glassfish.hk2.api.ServiceLocator locator)

Configure HK2 binders in the HK2 service locator and enable JAX-RS features.

Parameters:

locator - locator in which the binders and features should be configured.

registerManagedObjectsFinalizer

private void registerManagedObjectsFinalizer(org.glassfish.hk2.api.ServiceLocator locator)

configureBinders

private java.util.Set<org.glassfish.hk2.utilities.Binder> configureBinders(org.glassfish.hk2.api.ServiceLocator locator,
                                                                           java.util.Set<org.glassfish.hk2.utilities.Binder> configured)

getBinders

private java.util.Collection<org.glassfish.hk2.utilities.Binder> getBinders(java.util.Set<org.glassfish.hk2.utilities.Binder> configured)

configureFeatures

private void configureFeatures(org.glassfish.hk2.api.ServiceLocator locator,
                               java.util.Set<CommonConfig.FeatureRegistration> processed,
                               java.util.List<CommonConfig.FeatureRegistration> unprocessed)

resetRegistrations

private java.util.List<CommonConfig.FeatureRegistration> resetRegistrations()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object