ru.vyarus.dropwizard.guice.hook

Interface GuiceyConfigurationHook

All Known Implementing Classes:

DiagnosticHook

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface GuiceyConfigurationHook

Guicey configuration hook used to amend application configuration. Primarily intended to be used in tests with GuiceyHooksRule (junit) and UseGuiceyHooks (spock).

Hook could be registered with register() method call.

Also, could be used with GuiceyLifecycleListener (listener, implementing hook interface is recognized and registered automatically).

Hooks are thread-scoped: it is assumed that registration thread is the same thread where application will start.

Hooks could be enabled with a system property "guicey.hooks". Property value must contain comma-separated list of complete hook class names. Each hook in list must have default no-args constructor. Example: -Dguicey.hooks=com.foo.MyHook1,com.foo.MyHook2. Aliases may be assigned to simplify hooks enabling GuiceBundle.Builder#hookAlias(String, Class).

Enabling hooks from system property may be used for enabling reporting or additional tooling on already compiled applications. For example, bundled DiagnosticHook could enable guicey diagnostic reports (enabled during development with print* methods on GuiceBundle) with system property: -Dguicey.hooks=diagnostic.

Since:

11.04.2018

See Also:

GuiceyHooksRule, UseGuiceyHooks

Method Summary

Modifier and Type	Method and Description
void	configure(GuiceBundle.Builder builder) Configuration is applied just after manual configuration (through bundle's builder in application class).
default void	register() Register hook.

Method Detail

configure

void configure(GuiceBundle.Builder builder)

Configuration is applied just after manual configuration (through bundle's builder in application class).

GuiceBundle.Builder contains special methods for test support:

• Generic disable: GuiceBundle.Builder#disable(java.util.function.Predicate[])
• Direct disable* method, for example GuiceBundle.Builder#disableExtensions(Class[])
• Guice bindings override: GuiceBundle.Builder#modulesOverride(com.google.inject.Module...)

All other configuration options are also available, so it is possible to register extra extensions, bundles etc or modify guicey options (GuiceBundle.Builder#option(Enum, Object)).

All configuration items, registered with hook will be scoped as GuiceyConfigurationHook instead of Application and so will be clearly distinguishable in configuration logs (GuiceBundle.Builder#printDiagnosticInfo()).

Parameters:

builder - just created bundle's builder

See Also:

for more information

register

default void register()

Register hook. Note that it must be called before guicey bundle creation, otherwise will never be called.