org.glassfish.jersey.inject.hk2

Class ImmediateHk2InjectionManager

java.lang.Object

org.glassfish.jersey.inject.hk2.ImmediateHk2InjectionManager

All Implemented Interfaces:

org.glassfish.jersey.internal.inject.InjectionManager

public class ImmediateHk2InjectionManager
extends Object

Implementation of InjectionManager that is able to register and inject services.

Author:

Petr Bouda

Method Summary

Modifier and Type	Method and Description
void	completeRegistration() Completes InjectionManager and the underlying DI provider.
<U> U	create(Class<U> clazz) Creates an object with the given class.
<U> U	createAndInitialize(Class<U> clazz) 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.
<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.
ServiceLocator	getServiceLocator()
void	inject(Object injectMe) Analyzes 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.
boolean	isRegistrable(Class<?> clazz) Tests whether the provided clazz can be registered by the implementation of the InjectionManager.
void	preDestroy(Object preDestroyMe) Analyzes the given object and call the preDestroy method.
void	register(org.glassfish.jersey.internal.inject.Binder binder) Registers beans which are included in Binder.
void	register(org.glassfish.jersey.internal.inject.Binding binding) Registers one bean represented using fields in the provided descriptor.
void	register(Iterable<org.glassfish.jersey.internal.inject.Binding> descriptors) Registers a collection of beans represented using fields in the provided descriptors.
void	register(Object provider) Registers a provider.
void	shutdown() Shuts down the entire InjectionManager and the underlying DI provider.

Methods inherited from class java.lang.Object

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

Method Detail

completeRegistration

public void completeRegistration()
                          throws IllegalStateException

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

Completes InjectionManager and the underlying DI provider. All registered components are bound to injection manager and after an invocation of this method all components are available using e.g. InjectionManager.getInstance(Class).

Throws:

IllegalStateException

register

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

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

Registers 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.

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

Registers 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.

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

Registers 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.

Parameters:

binder - collection of descriptors.

See Also:

ClassBinding, InstanceBinding, SupplierClassBinding, SupplierInstanceBinding

register

public void register(Object provider)

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

Registers a provider. An implementation of the InjectionManager should test whether the type of the object can be registered using the method InjectionManager.isRegistrable(Class). Then a caller has an certainty that the instance of the tested class can be registered in InjectionManager. If InjectionManager is not able to register the provider then IllegalArgumentException is thrown.

Parameters:

provider - object that can be registered in InjectionManager.

getServiceLocator

public ServiceLocator getServiceLocator()

isRegistrable

public boolean isRegistrable(Class<?> clazz)

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

Tests whether the provided clazz can be registered by the implementation of the InjectionManager.

Specified by:

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

Parameters:

clazz - type that is tested whether is registrable by the implementation of InjectionManager.

Returns:

true if the InjectionManager is able to register this type.

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.

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

preDestroy

public void preDestroy(Object preDestroyMe)

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

Analyzes 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

shutdown

public void shutdown()

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

Shuts down the entire InjectionManager and the underlying DI provider.

Shutdown phase is dedicated to make some final cleaning steps regarding underlying DI provider.

Specified by:

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

create

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

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

Creates an object with the given class.

The object created is not managed by the injection manager.

Specified by:

create 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.

createAndInitialize

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

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

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.

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.

inject

public void inject(Object injectMe)

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

Analyzes 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