Package 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<Object>
ru.vyarus.dropwizard.guice.module.installer.feature.jersey.ResourceInstaller
All Implemented Interfaces:
FeatureInstaller, BindingInstaller, JerseyInstaller<Object>, TypeInstaller<Object>, WebInstaller, WithOptions
public class ResourceInstaller extends AbstractJerseyInstaller<Object> implements BindingInstaller, TypeInstaller<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

  • Constructor Details

    • ResourceInstaller

      public ResourceInstaller()

  • Method Details

    • matches

      public boolean matches(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
      Parameters:
      type - type to check
      Returns:
      true if extension recognized, false otherwise

    • bind

      public void bind(com.google.inject.Binder binder, 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:
      bind in interface BindingInstaller
      Parameters:
      binder - guice binder
      type - extension class
      lazyMarker - true if extension is annotated with LazyBinding

    • manualBinding

      public <T> void manualBinding(com.google.inject.Binder binder, Class<T> type, com.google.inject.Binding<T> binding)
      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. Binding is detected primarily by main key Binding.getKey(), but linked bindings (LinkedKeyBinding) are also checked for target key (LinkedKeyBinding.getLinkedKey()).

      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:
      manualBinding in interface BindingInstaller
      Type Parameters:
      T - extension type, used to connect extension class with binding
      Parameters:
      binder - guice binder
      type - extension class
      binding - binding declaration from guice module
      See Also:

    • install

      public void install(io.dropwizard.core.setup.Environment environment, Class<Object> type)
      Description copied from interface: TypeInstaller
      Full Injector could be obtained with InjectorLookup.getInjector(Environment).

      Shared state could be obtained with SharedConfigurationState.get(Environment)

      Specified by:
      install in interface TypeInstaller<Object>
      Parameters:
      environment - environment object
      type - extension type

    • install

      public void install(org.glassfish.jersey.internal.inject.AbstractBinder binder, com.google.inject.Injector injector, Class<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<Object>
      Parameters:
      binder - hk binder
      injector - guice injector
      type - extension type to register
      See Also:

    • 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

    • getRecognizableSigns

      public List<String> getRecognizableSigns()
      Description copied from interface: FeatureInstaller
      Method used by extensions help report (GuiceBundle.Builder.printExtensionsHelp()) to show what signs this exact installer recognize so user could better understand extensions support specifics.
      Specified by:
      getRecognizableSigns in interface FeatureInstaller
      Returns:
      list of extension signs installer recognize