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

Class ResourceInstaller

java.lang.Object

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

All Implemented Interfaces:

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

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

Jersey resource installer. Search classes annotated with Path. Directly register instance in jersey context to force singleton. If we register it by type, then we could use prototype beans (resource instance created on each request), which will lead to performance overhead. To ovoid misuse, singleton resources are forced. Override installer if you really need prototype resources.

Since:

01.09.2014

Constructor Summary

Constructors

Constructor and Description
ResourceInstaller()

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.
void	install(io.dropwizard.setup.Environment environment, java.lang.Class<java.lang.Object> type)
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

ResourceInstaller

public ResourceInstaller()

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(io.dropwizard.setup.Environment environment,
                    java.lang.Class<java.lang.Object> type)

Specified by:

install in interface TypeInstaller<java.lang.Object>

Parameters:

environment - environment object

type - extension type

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>