org.spincast.core.guice

Class GuiceTweaker

java.lang.Object

org.spincast.core.guice.GuiceTweaker

All Implemented Interfaces:

SpincastContextTypesInterested, SpincastPlugin

public class GuiceTweaker
extends Object
implements SpincastPlugin

Spincast plugin made available through a ThreadLocal.

This allows the tweaking of the Guice context of an application without touching its bootstrapping code.

The first use case for this is to be able to mock some parts of an application in order to test it.

It is the responsibility of the code creating the GuiceTweaker to make sure the ThreadLocal variable is removed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLUGIN_ID
static ThreadLocal<GuiceTweaker>	threadLocal

Constructor Summary

Constructors

Constructor and Description
GuiceTweaker()

Method Summary

Modifier and Type	Method and Description
com.google.inject.Module	apply(com.google.inject.Module currentModule) Applies the plugin.
void	bindCurrentClassByDefault(boolean bindCurrentClassByDefault)
void	createdGuiceInjector(com.google.inject.Injector injector) Once all the plugins have been applied, this method is called with the resulting Guice injector.
protected List<SpincastPlugin>	getExtraPlugins()
String	getId() The id of the plugin.
com.google.inject.Injector	getInjector()
protected Set<com.google.inject.Module>	getModules()
Set<String>	getPluginsToDisable() If required, the ids of plugins that shouldn't be installed.
boolean	isBindCurrentClassByDefault()
void	module(com.google.inject.Module module)
void	plugin(SpincastPlugin plugin)
void	pluginToDisable(String pluginId)
void	setRequestContextImplementationClass(Class<? extends RequestContext<?>> requestContextImplementationClass) The implementation class to use for RequestContext.
void	setWebsocketContextImplementationClass(Class<? extends WebsocketContext<?>> websocketContextImplementationClass) The implementation class to use for WebsocletContext.

Methods inherited from class java.lang.Object

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

Field Detail

threadLocal

public static final ThreadLocal<GuiceTweaker> threadLocal

PLUGIN_ID

public static final String PLUGIN_ID

Constructor Detail

GuiceTweaker

public GuiceTweaker()

Method Detail

getId

public String getId()

Description copied from interface: SpincastPlugin

The id of the plugin.

Specified by:

getId in interface SpincastPlugin

getExtraPlugins

protected List<SpincastPlugin> getExtraPlugins()

getModules

protected Set<com.google.inject.Module> getModules()

isBindCurrentClassByDefault

public boolean isBindCurrentClassByDefault()

createdGuiceInjector

public void createdGuiceInjector(com.google.inject.Injector injector)

Description copied from interface: SpincastPlugin

Once all the plugins have been applied, this method is called with the resulting Guice injector.

Specified by:

createdGuiceInjector in interface SpincastPlugin

getInjector

public com.google.inject.Injector getInjector()

apply

public com.google.inject.Module apply(com.google.inject.Module currentModule)

Description copied from interface: SpincastPlugin

Applies the plugin.

The plugin can add bindings to the current Guice module, can modify it and can inspect it in order to decide what to bind or not.

Specified by:

apply in interface SpincastPlugin

Returns:

an ajusted Guice module.

getPluginsToDisable

public Set<String> getPluginsToDisable()

Description copied from interface: SpincastPlugin

If required, the ids of plugins that shouldn't be installed.

This plugin is repsonsible to bind any components that won't be bound because it mark some plugins as to be ignored.

Specified by:

getPluginsToDisable in interface SpincastPlugin

setRequestContextImplementationClass

public void setRequestContextImplementationClass(Class<? extends RequestContext<?>> requestContextImplementationClass)

Description copied from interface: SpincastPlugin

The implementation class to use for RequestContext.

Specified by:

setRequestContextImplementationClass in interface SpincastContextTypesInterested

Specified by:

setRequestContextImplementationClass in interface SpincastPlugin

setWebsocketContextImplementationClass

public void setWebsocketContextImplementationClass(Class<? extends WebsocketContext<?>> websocketContextImplementationClass)

Description copied from interface: SpincastPlugin

The implementation class to use for WebsocletContext.

Specified by:

setWebsocketContextImplementationClass in interface SpincastContextTypesInterested

Specified by:

setWebsocketContextImplementationClass in interface SpincastPlugin

module

public void module(com.google.inject.Module module)

plugin

public void plugin(SpincastPlugin plugin)

bindCurrentClassByDefault

public void bindCurrentClassByDefault(boolean bindCurrentClassByDefault)

pluginToDisable

public void pluginToDisable(String pluginId)