org.glassfish.jersey.internal.inject

Class Injections

java.lang.Object

org.glassfish.jersey.internal.inject.Injections

public class Injections
extends Object

HK2 injection binding utility methods.

Author:

Tom Beerbower, Marek Potociar (marek.potociar at oracle.com)

Constructor Summary

Constructors

Constructor and Description
Injections()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addBinding(org.glassfish.hk2.utilities.binding.BindingBuilder<?> builder, org.glassfish.hk2.api.DynamicConfiguration configuration) Add a binding represented by the binding builder to the HK2 dynamic configuration.
static void	addBinding(org.glassfish.hk2.utilities.binding.BindingBuilder<?> builder, org.glassfish.hk2.api.DynamicConfiguration configuration, org.glassfish.hk2.api.HK2Loader defaultLoader) Add a binding represented by the binding builder to the HK2 dynamic configuration.
static org.glassfish.hk2.api.ServiceLocator	createLocator(org.glassfish.hk2.utilities.Binder... binders) Create an unnamed ServiceLocator.
static org.glassfish.hk2.api.ServiceLocator	createLocator(org.glassfish.hk2.api.ServiceLocator parent, org.glassfish.hk2.utilities.Binder... binders) Create an unnamed, parented ServiceLocator.
static org.glassfish.hk2.api.ServiceLocator	createLocator(String name, org.glassfish.hk2.utilities.Binder... binders) Create a ServiceLocator.
static org.glassfish.hk2.api.ServiceLocator	createLocator(String name, org.glassfish.hk2.api.ServiceLocator parent, org.glassfish.hk2.utilities.Binder... binders) Create a ServiceLocator.
static org.glassfish.hk2.api.DynamicConfiguration	getConfiguration(org.glassfish.hk2.api.ServiceLocator locator) Get service locator dynamic configuration.
static <T> T	getOrCreate(org.glassfish.hk2.api.ServiceLocator serviceLocator, Class<T> clazz) Get the class by contract or create and inject a new instance.
static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T>	newBinder(Class<T> serviceType) Get a new class-based service binding builder.
static <T> org.glassfish.hk2.utilities.binding.ScopedBindingBuilder<T>	newBinder(T service) Get a new instance-based service binding builder.
static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T>	newFactoryBinder(Class<? extends org.glassfish.hk2.api.Factory<T>> factoryType) Get a new factory class-based service binding builder.
static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T>	newFactoryBinder(Class<? extends org.glassfish.hk2.api.Factory<T>> factoryType, Class<? extends Annotation> factoryScope) Get a new factory class-based service binding builder.
static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T>	newFactoryBinder(org.glassfish.hk2.api.Factory<T> factory) Get a new factory instance-based service binding builder.
static void	shutdownLocator(org.glassfish.hk2.api.ServiceLocator locator) Shutdown ServiceLocator - either via service locator factory (if possible) or directly by calling shutdown method.

Methods inherited from class java.lang.Object

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

Constructor Detail

Injections

public Injections()

Method Detail

getConfiguration

public static org.glassfish.hk2.api.DynamicConfiguration getConfiguration(org.glassfish.hk2.api.ServiceLocator locator)

Get service locator dynamic configuration.

Parameters:

locator - HK2 service locator.

Returns:

dynamic configuration for a given service locator.

createLocator

public static org.glassfish.hk2.api.ServiceLocator createLocator(String name,
                                                 org.glassfish.hk2.api.ServiceLocator parent,
                                                 org.glassfish.hk2.utilities.Binder... binders)

Create a ServiceLocator. In case the name is not specified, the locator will be unnamed.

Parameters:

name - The name of this service locator. Passing a null name will result in a newly created service locator with a generated name.

parent - The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null. if the returned ServiceLocator should not be parented.

binders - custom the HK2 binders.

Returns:

a service locator with all the bindings.

createLocator

public static org.glassfish.hk2.api.ServiceLocator createLocator(String name,
                                                 org.glassfish.hk2.utilities.Binder... binders)

Create a ServiceLocator. In case the name is not specified, the locator will be unnamed.

Parameters:

name - The name of this service locator. Passing a null name will result in a newly created service locator with a generated name.

binders - custom the HK2 binders.

Returns:

a service locator with all the bindings.

createLocator

public static org.glassfish.hk2.api.ServiceLocator createLocator(org.glassfish.hk2.api.ServiceLocator parent,
                                                 org.glassfish.hk2.utilities.Binder... binders)

Create an unnamed, parented ServiceLocator. In case the parent service locator is not specified, the locator will not be parented.

Parameters:

parent - The parent of this ServiceLocator. Services can be found in the parent (and all grand-parents). May be null. if the returned ServiceLocator should not be parented.

binders - custom the HK2 binders.

Returns:

a service locator with all the bindings.

createLocator

public static org.glassfish.hk2.api.ServiceLocator createLocator(org.glassfish.hk2.utilities.Binder... binders)

Create an unnamed ServiceLocator.

Parameters:

binders - custom the HK2 binders.

Returns:

a service locator with all the bindings.

getOrCreate

public static <T> T getOrCreate(org.glassfish.hk2.api.ServiceLocator serviceLocator,
                Class<T> clazz)

Get the class by contract or create and inject a new instance.

Type Parameters:

T - instance type.

Parameters:

serviceLocator - HK2 service locator.

clazz - class of the instance to be provider.

Returns:

instance of the class either provided as a service or created and injected by HK2.

addBinding

public static void addBinding(org.glassfish.hk2.utilities.binding.BindingBuilder<?> builder,
              org.glassfish.hk2.api.DynamicConfiguration configuration)

Add a binding represented by the binding builder to the HK2 dynamic configuration.

Parameters:

builder - binding builder.

configuration - HK2 dynamic configuration.

addBinding

public static void addBinding(org.glassfish.hk2.utilities.binding.BindingBuilder<?> builder,
              org.glassfish.hk2.api.DynamicConfiguration configuration,
              org.glassfish.hk2.api.HK2Loader defaultLoader)

Add a binding represented by the binding builder to the HK2 dynamic configuration.

Parameters:

builder - binding builder.

configuration - HK2 dynamic configuration.

defaultLoader - default HK2 service loader that should be used to load the service class in case a custom loader has not been set.

newFactoryBinder

public static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T> newFactoryBinder(Class<? extends org.glassfish.hk2.api.Factory<T>> factoryType,
                                                                                Class<? extends Annotation> factoryScope)

Get a new factory class-based service binding builder.

Type Parameters:

T - service type.

Parameters:

factoryType - service factory class.

factoryScope - factory scope.

Returns:

initialized binding builder.

newFactoryBinder

public static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T> newFactoryBinder(Class<? extends org.glassfish.hk2.api.Factory<T>> factoryType)

Get a new factory class-based service binding builder. The factory itself is bound in a per-lookup scope.

Type Parameters:

T - service type.

Parameters:

factoryType - service factory class.

Returns:

initialized binding builder.

newFactoryBinder

public static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T> newFactoryBinder(org.glassfish.hk2.api.Factory<T> factory)

Get a new factory instance-based service binding builder.

Type Parameters:

T - service type.

Parameters:

factory - service instance.

Returns:

initialized binding builder.

newBinder

public static <T> org.glassfish.hk2.utilities.binding.ServiceBindingBuilder<T> newBinder(Class<T> serviceType)

Get a new class-based service binding builder. Does NOT bind the service type itself as a contract type.

Type Parameters:

T - service type.

Parameters:

serviceType - service class.

Returns:

initialized binding builder.

newBinder

public static <T> org.glassfish.hk2.utilities.binding.ScopedBindingBuilder<T> newBinder(T service)

Get a new instance-based service binding builder. The binding is naturally considered to be a singleton-scoped. Does NOT bind the service type itself as a contract type.

Type Parameters:

T - service type.

Parameters:

service - service instance.

Returns:

initialized binding builder.

shutdownLocator

public static void shutdownLocator(org.glassfish.hk2.api.ServiceLocator locator)

Shutdown ServiceLocator - either via service locator factory (if possible) or directly by calling shutdown method.

Parameters:

locator - locator to be shut down.