ru.vyarus.dropwizard.guice.module.installer.feature.jersey.provider

Class JerseyProviderInstaller

java.lang.Object

ru.vyarus.dropwizard.guice.module.installer.feature.jersey.provider.JerseyProviderInstaller

All Implemented Interfaces:

FeatureInstaller<java.lang.Object>, BindingInstaller, JerseyInstaller<java.lang.Object>

public class JerseyProviderInstaller
extends java.lang.Object
implements FeatureInstaller<java.lang.Object>, BindingInstaller, JerseyInstaller<java.lang.Object>

Jersey provider installer. Looks for classes annotated with @javax.ws.rs.ext.Provider and register bindings in HK context.

If provider is annotated with HK2Managed it's instance will be created by HK2, not guice. This is important when extensions directly depends on HK beans (no way to wrap with Provider or if it's eager extension, which instantiated by HK immediately (when hk-guice contexts not linked yet).

In some cases @LazyBinding could be an alternative to HK2Managed

Since:

10.10.2014

See Also:

HK2Managed, LazyBinding

Constructor Summary

Constructors

Constructor and Description
JerseyProviderInstaller()

Method Summary

Modifier and Type	Method and Description
void	install(org.glassfish.hk2.utilities.binding.AbstractBinder binder, com.google.inject.Injector injector, java.lang.Class<java.lang.Object> type) Called on jersey start to inject extensions into HK context.
<T> void	install(com.google.inject.Binder binder, java.lang.Class<? extends T> type, boolean lazy) Called to apply custom binding for installed feature.
boolean	matches(java.lang.Class<?> type) NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).
void	report() Called to log registered endpoints in dropwizard log fashion.

Methods inherited from class java.lang.Object

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

Constructor Detail

JerseyProviderInstaller

public JerseyProviderInstaller()

Method Detail

matches

public boolean matches(java.lang.Class<?> type)

Description copied from interface: FeatureInstaller

NOTE: consider using ru.vyarus.dropwizard.guice.module.installer.util.FeatureUtils to simplify checks (for example, types most likely must be checks to be not abstract).

When type accepted by any extension it's registered in guice module.

Specified by:

matches in interface FeatureInstaller<java.lang.Object>

Parameters:

type - type to check

Returns:

true if extension recognized, false otherwise

install

public <T> void install(com.google.inject.Binder binder,
                        java.lang.Class<? extends T> type,
                        boolean lazy)

Description copied from interface: BindingInstaller

Called to apply custom binding for installed feature. All found features installed as binder.install(type) by default, so implement it only if some custom binding required.

Specified by:

install in interface BindingInstaller

Type Parameters:

T - plugin type (used just to define strict hierarchy and simplify binding)

Parameters:

binder - guice binder

type - extension class

lazy - true if extension is annotated with @LazyBinding

install

public void install(org.glassfish.hk2.utilities.binding.AbstractBinder binder,
                    com.google.inject.Injector injector,
                    java.lang.Class<java.lang.Object> type)

Description copied from interface: JerseyInstaller

Called on jersey start to inject extensions into HK context. Use JerseyBinding utility for proper types binding: it provide utilities for various jersey extensions and use special "bridges" for registration to respect guice scopes (most of the time we not register ready instance, but factory which delegates creation to guice).

Specified by:

install in interface JerseyInstaller<java.lang.Object>

Parameters:

binder - hk binder

injector - guice injector

type - extension type to register

See Also:

JerseyBinding, HK2Managed

report

public void report()

Description copied from interface: FeatureInstaller

Called to log registered endpoints in dropwizard log fashion. It's important to naturally show all dynamically resolved classes to easily catch errors. Use Reporter to simplify reporting.

Method may do nothing if reporting not required

Specified by:

report in interface FeatureInstaller<java.lang.Object>