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

Class ResourceInstaller

java.lang.Object

ru.vyarus.dropwizard.guice.module.installer.option.InstallerOptionsSupport

ru.vyarus.dropwizard.guice.module.installer.feature.jersey.AbstractJerseyInstaller<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>, WithOptions

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

Jersey resource installer. Search classes annotated with Path or implementing interfaces annotated with Path (only directly implemented). 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, but not for beans having explicit scope annotation. See InstallersOptions.ForceSingletonForJerseyExtensions.

Prototype annotation may be used to force prototype scope on guice beans (prevent forced singleton). This may be useful to avoid providers usage and directly inject request, response and other request specific beans. Note that jersey managed resources may use direct injections even in singletons (as jersey will use proxies instead of direct dependencies - implicit providers).

Since:

01.09.2014

Field Summary

Fields inherited from class ru.vyarus.dropwizard.guice.module.installer.feature.jersey.AbstractJerseyInstaller

logger

Constructor Summary

Constructors

Constructor and Description
ResourceInstaller()

Method Summary

Modifier and Type	Method and Description
void	bindExtension(com.google.inject.Binder binder, java.lang.Class<?> type, boolean lazyMarker) Called to apply custom binding for installed feature.
<T> void	checkBinding(com.google.inject.Binder binder, java.lang.Class<T> type, com.google.inject.Binding<T> manualBinding) Called for extensions, resolved from guice bindings (in user modules).
void	install(org.glassfish.jersey.internal.inject.AbstractBinder binder, com.google.inject.Injector injector, java.lang.Class<java.lang.Object> type) Called on jersey start to inject extensions into HK context.
void	install(io.dropwizard.setup.Environment environment, java.lang.Class<java.lang.Object> type)
void	installBinding(com.google.inject.Binder binder, java.lang.Class<?> type) Called after execution of one of above methods.
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 ru.vyarus.dropwizard.guice.module.installer.feature.jersey.AbstractJerseyInstaller

bindInGuice, isForceSingleton, isJerseyExtension, isLazy

Methods inherited from class ru.vyarus.dropwizard.guice.module.installer.option.InstallerOptionsSupport

option, setOptions

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

bindExtension

public void bindExtension(com.google.inject.Binder binder,
                          java.lang.Class<?> type,
                          boolean lazyMarker)

Description copied from interface: BindingInstaller

Called to apply custom binding for installed feature. By default, all found extensions are installed as binder.bind(type). This method will be called instead of default registration.

Called only for non binding extensions (extensions that are not already bound in guice module.

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

bindExtension in interface BindingInstaller

Parameters:

binder - guice binder

type - extension class

lazyMarker - true if extension is annotated with LazyBinding

checkBinding

public <T> void checkBinding(com.google.inject.Binder binder,
                             java.lang.Class<T> type,
                             com.google.inject.Binding<T> manualBinding)

Description copied from interface: BindingInstaller

Called for extensions, resolved from guice bindings (in user modules). May be used to validate binding or do some additional bindings with existing binding.

LazyBinding flag is not used here because guicey will automatically throw an error if existing binding is annotated as lazy binding (which don't makes any sense).

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

checkBinding in interface BindingInstaller

Type Parameters:

T - extension type, used to connect extension class with binding

Parameters:

binder - guice binder

type - extension class

manualBinding - binding declaration from guice module

See Also:

for errors reporting

installBinding

public void installBinding(com.google.inject.Binder binder,
                           java.lang.Class<?> type)

Description copied from interface: BindingInstaller

Called after execution of one of above methods. May be useful to perform common actions for both cases or simply for reporting.

WARNING: may be called multiple times due to enabled bindings reporting! Be sure to produce correct logs.

Specified by:

installBinding in interface BindingInstaller

Parameters:

binder - guice binder

type - extension class

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.jersey.internal.inject.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, JerseyManaged

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>