org.glassfish.jersey.server.spring

Class SpringComponentProvider

java.lang.Object

org.glassfish.jersey.server.spring.SpringComponentProvider

All Implemented Interfaces:

ComponentProvider

public class SpringComponentProvider
extends Object
implements ComponentProvider

Custom ComponentProvider class. Responsible for 1) bootstrapping Jersey 2 Spring integration and 2) making Jersey skip JAX-RS Spring component life-cycle management and leave it to us.

Author:

Marko Asplund (marko.asplund at yahoo.com)

Constructor Summary

Constructors

Constructor and Description
SpringComponentProvider()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	bind(Class<?> component, Set<Class<?>> providerContracts) Jersey will invoke this method before binding of each component class internally during initialization of it's HK2 service locator.
void	done() Jersey will invoke this method after all component classes have been bound.
void	initialize(org.glassfish.hk2.api.ServiceLocator locator) Initializes the component provider with a reference to a HK2 service locator instance, which will get used in the application to manage individual components.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpringComponentProvider

public SpringComponentProvider()

Method Detail

initialize

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

Description copied from interface: ComponentProvider

Initializes the component provider with a reference to a HK2 service locator instance, which will get used in the application to manage individual components. Providers should keep a reference to the HK2 service locator for later use. This method will be invoked prior to any bind method calls. The service locator parameter will not be fully initialized at the time of invocation and should be used as a reference only.

Specified by:

initialize in interface ComponentProvider

Parameters:

locator - an HK2 service locator.

bind

public boolean bind(Class<?> component,
           Set<Class<?>> providerContracts)

Description copied from interface: ComponentProvider

Jersey will invoke this method before binding of each component class internally during initialization of it's HK2 service locator. If the component provider wants to bind the component class itself, it must do so and return true. In that case, Jersey will not bind the component and rely on the component provider in this regard.

Specified by:

bind in interface ComponentProvider

Parameters:

component - a component (resource/provider) class.

providerContracts - provider contracts implemented by given component.

Returns:

true if the component class has been bound by the provider, false otherwise

done

public void done()

Description copied from interface: ComponentProvider

Jersey will invoke this method after all component classes have been bound. If the component provider wants to do some actions after it has seen all component classes registered with the application, this is the right place for the corresponding code.

Specified by:

done in interface ComponentProvider