org.glassfish.jersey.hk2

Class HK2InjectionManager

java.lang.Object

org.glassfish.jersey.hk2.HK2InjectionManager

All Implemented Interfaces:

org.glassfish.jersey.internal.inject.InjectionManager

public class HK2InjectionManager
extends Object
implements org.glassfish.jersey.internal.inject.InjectionManager

Implementation of InjectionManager for HK Dependency Injection Framework.

Constructor Summary

Constructors

Constructor and Description
HK2InjectionManager() Default constructor to be able to find a HK2InjectionManager using ServiceLoader.

Method Summary

Modifier and Type	Method and Description
<U> U	createAndInitialize(Class<U> clazz) This method creates, injects and post-constructs an object with the given class.
org.glassfish.jersey.internal.inject.ForeignDescriptor	createForeignDescriptor(org.glassfish.jersey.internal.inject.Binding binding) Creates and registers the descriptor in the underlying DI provider and returns ForeignDescriptor that is specific descriptor for the underlying DI provider.
static org.glassfish.jersey.internal.inject.InjectionManager	createInjectionManager(org.glassfish.hk2.api.ServiceLocator locator) Creates a new instance of HK2InjectionManager and automatically add the provided instance of ServiceLocator as a underlying injection manager.
<T> List<T>	getAllInstances(Type clazz) Gets all services from this injection manager that implement this contract or have this implementation.
<T> List<org.glassfish.jersey.internal.inject.ServiceHolder<T>>	getAllServiceHolders(Class<T> contract, Annotation... qualifiers) Gets all services from this injection manager that implements this contract or has this implementation along with information about the service which can be kept by ServiceHolder.
<T> T	getInstance(Class<T> clazz) Gets the best service from this injection manager that implements this contract or has this implementation.
<T> T	getInstance(Class<T> clazz, Annotation... annotations) Gets the best service from this injection manager that implements this contract or has this implementation.
<T> T	getInstance(Class<T> clazz, String classAnalyzer) Gets the best service from this injection manager that implements this contract or has this implementation.
Object	getInstance(org.glassfish.jersey.internal.inject.ForeignDescriptor foreignDescriptor) Gets the service instance according to ForeignDescriptor which is specific to the underlying DI provider.
<T> T	getInstance(Type clazz) Gets the best service from this injection manager that implements this contract or has this implementation.
org.glassfish.hk2.api.ServiceLocator	getServiceLocator() Returns ServiceLocator dedicated to this instance of HK2InjectionManager.
void	initialize(String name, Object parent, org.glassfish.jersey.internal.inject.Binder... binders) This will initialize the InjectionManager and underlying DI provider.
void	inject(Object injectMe) This will analyze the given object and inject into its fields and methods.
void	inject(Object injectMe, String classAnalyzer) This will analyze the given object and inject into its fields and methods.
void	preDestroy(Object preDestroyMe) This will analyze the given object and call the preDestroy method.
void	register(org.glassfish.hk2.utilities.Binder... binder) Register a HK2 Binder.
void	register(org.glassfish.jersey.internal.inject.Binder binder) This will register beans which are included in Binder.
void	register(org.glassfish.jersey.internal.inject.Binding binding) This will register one bean represented using fields in the provided descriptor.
void	register(Iterable<org.glassfish.jersey.internal.inject.Binding> descriptors) This will register a collection of beans represented using fields in the provided descriptors.
void	shutdown() This will shutdown the entire injection manager and underlying DI provider along with injected executors and schedulers.

Methods inherited from class java.lang.Object

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

Constructor Detail

HK2InjectionManager

public HK2InjectionManager()

Default constructor to be able to find a HK2InjectionManager using ServiceLoader.

Method Detail

createInjectionManager

public static org.glassfish.jersey.internal.inject.InjectionManager createInjectionManager(org.glassfish.hk2.api.ServiceLocator locator)

Creates a new instance of HK2InjectionManager and automatically add the provided instance of ServiceLocator as a underlying injection manager.

Commonly used in this scenarios: - create InjectionManager with externally provided ServiceLocator. - create InjectionManager which is immediately put into the different InjectionManager as a parent.

Parameters:

locator - HK2 ServiceLocator

Returns:

new instance of HK2InjectionManager with underlying ServiceLocator.

getServiceLocator

public org.glassfish.hk2.api.ServiceLocator getServiceLocator()

Returns ServiceLocator dedicated to this instance of HK2InjectionManager.

Returns:

underlying instance of ServiceLocator.

initialize

public void initialize(String name,
                       Object parent,
                       org.glassfish.jersey.internal.inject.Binder... binders)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will initialize the InjectionManager and underlying DI provider. The method may get the array of binders to register Binding them during initialization process. name and parent are not required parameters and can be null without the initialization exception.

Specified by:

initialize in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

name - Name of the injection manager.

parent - Parent object of the underlying DI provider on which new injection manager should be dependent. A specific DI provider checks whether the parent object is in the proper type of underlying service storage or a proper implementation of InjectionManager.

binders - Binders with descriptions to include them during initialization process.

shutdown

public void shutdown()

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will shutdown the entire injection manager and underlying DI provider along with injected executors and schedulers.

Specified by:

shutdown in interface org.glassfish.jersey.internal.inject.InjectionManager

register

public void register(org.glassfish.jersey.internal.inject.Binding binding)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will register one bean represented using fields in the provided descriptor. The final bean can be direct bean or factory object which will create the bean at the time of injection. InjectionManager is able to register a bean represented by a class or direct instance.

Specified by:

register in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

binding - one descriptor.

See Also:

ClassBinding, InstanceBinding, SupplierClassBinding, SupplierInstanceBinding

register

public void register(Iterable<org.glassfish.jersey.internal.inject.Binding> descriptors)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will register a collection of beans represented using fields in the provided descriptors. The final bean can be direct bean or factory object which will create the bean at the time of injection. InjectionManager is able to register a bean represented by a class or direct instance.

Specified by:

register in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

descriptors - collection of descriptors.

See Also:

ClassBinding, InstanceBinding, SupplierClassBinding, SupplierInstanceBinding

register

public void register(org.glassfish.jersey.internal.inject.Binder binder)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will register beans which are included in Binder. Binder can contains all descriptors extending Binding or other binders which are installed together in tree-structure. This method will get all descriptors bound in the given binder and register them in the order how the binders are installed together. In the tree structure, the deeper on the left side will be processed first.

Specified by:

register in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

binder - collection of descriptors.

See Also:

ClassBinding, InstanceBinding, SupplierClassBinding, SupplierInstanceBinding

register

public void register(org.glassfish.hk2.utilities.Binder... binder)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Register a HK2 Binder. For compatibility reasons only, to be removed.

Specified by:

register in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

binder - collection of descriptors.

See Also:

ClassBinding, InstanceBinding, SupplierClassBinding, SupplierInstanceBinding

createAndInitialize

public <U> U createAndInitialize(Class<U> clazz)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This method creates, injects and post-constructs an object with the given class. This is equivalent to calling the create-class method followed by the inject-class method followed by the post-construct method.

The object created is not managed by the injection manager.

Specified by:

createAndInitialize in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

clazz - The non-null class to create this object from;

Returns:

An instance of the object that has been created, injected and post constructed.

getAllServiceHolders

public <T> List<org.glassfish.jersey.internal.inject.ServiceHolder<T>> getAllServiceHolders(Class<T> contract,
                                                                                            Annotation... qualifiers)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets all services from this injection manager that implements this contract or has this implementation along with information about the service which can be kept by ServiceHolder.

Specified by:

getAllServiceHolders in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

contract - May not be null, and is the contract or concrete implementation to get the best instance of.

qualifiers - The set of qualifiers that must match this service definition.

Returns:

An instance of the contract or impl along with other information. May return null if there is no provider that provides the given implementation or contract.

getInstance

public <T> T getInstance(Class<T> clazz,
                         Annotation... annotations)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets the best service from this injection manager that implements this contract or has this implementation.

Use this method only if other information is not needed otherwise use, otherwise use InjectionManager.getAllServiceHolders(Class, Annotation...).

Specified by:

getInstance in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

clazz - May not be null, and is the contract or concrete implementation to get the best instance of.

annotations - The set of qualifiers that must match this service definition.

Returns:

An instance of the contract or impl. May return null if there is no provider that provides the given implementation or contract.

getInstance

public <T> T getInstance(Type clazz)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets the best service from this injection manager that implements this contract or has this implementation.

Use this method only if other information is not needed otherwise use, otherwise use InjectionManager.getAllServiceHolders(Class, Annotation...).

Specified by:

getInstance in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

clazz - May not be null, and is the contract or concrete implementation to get the best instance of.

Returns:

An instance of the contract or impl. May return null if there is no provider that provides the given implementation or contract.

getInstance

public Object getInstance(org.glassfish.jersey.internal.inject.ForeignDescriptor foreignDescriptor)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets the service instance according to ForeignDescriptor which is specific to the underlying DI provider.

Specified by:

getInstance in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

foreignDescriptor - DI specific descriptor.

Returns:

service instance according to foreign descriptor.

createForeignDescriptor

public org.glassfish.jersey.internal.inject.ForeignDescriptor createForeignDescriptor(org.glassfish.jersey.internal.inject.Binding binding)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Creates and registers the descriptor in the underlying DI provider and returns ForeignDescriptor that is specific descriptor for the underlying DI provider.

Specified by:

createForeignDescriptor in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

binding - jersey descriptor.

Returns:

specific foreign descriptor of the underlying DI provider.

getInstance

public <T> T getInstance(Class<T> clazz)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets the best service from this injection manager that implements this contract or has this implementation.

Use this method only if other information is not needed otherwise use, otherwise use InjectionManager.getAllServiceHolders(Class, Annotation...).

Specified by:

getInstance in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

clazz - May not be null, and is the contract or concrete implementation to get the best instance of.

Returns:

An instance of the contract or impl. May return null if there is no provider that provides the given implementation or contract.

getInstance

public <T> T getInstance(Class<T> clazz,
                         String classAnalyzer)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets the best service from this injection manager that implements this contract or has this implementation.

Use this method only if other information is not needed otherwise use, otherwise use InjectionManager.getAllServiceHolders(Class, Annotation...).

Specified by:

getInstance in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

clazz - May not be null, and is the contract or concrete implementation to get the best instance of.

classAnalyzer - -------

Returns:

An instance of the contract or impl. May return null if there is no provider that provides the given implementation or contract.

getAllInstances

public <T> List<T> getAllInstances(Type clazz)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

Gets all services from this injection manager that implement this contract or have this implementation.

Use this method only if other information is not needed otherwise use, otherwise use InjectionManager.getAllServiceHolders(Class, Annotation...).

Specified by:

getAllInstances in interface org.glassfish.jersey.internal.inject.InjectionManager

Type Parameters:

T - Instance type.

Parameters:

clazz - May not be null, and is the contract or concrete implementation to get the best instance of.

Returns:

A list of services implementing this contract or concrete implementation. May not return null, but may return an empty list

inject

public void inject(Object injectMe)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will analyze the given object and inject into its fields and methods. The object injected in this way will not be managed by HK2

Specified by:

inject in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

injectMe - The object to be analyzed and injected into

inject

public void inject(Object injectMe,
                   String classAnalyzer)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will analyze the given object and inject into its fields and methods. The object injected in this way will not be managed by HK2

Specified by:

inject in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

injectMe - The object to be analyzed and injected into

preDestroy

public void preDestroy(Object preDestroyMe)

Description copied from interface: org.glassfish.jersey.internal.inject.InjectionManager

This will analyze the given object and call the preDestroy method. The object given will not be managed by bean manager.

Specified by:

preDestroy in interface org.glassfish.jersey.internal.inject.InjectionManager

Parameters:

preDestroyMe - The object to preDestroy