org.spincast.core.guice

Interface SpincastPlugin

All Superinterfaces:

SpincastContextTypesInterested

All Known Implementing Classes:

GuiceTweaker, SpincastConfigPlugin, SpincastConfigPropsFilePlugin, SpincastCookiesPlugin, SpincastCorePlugin, SpincastDictionaryPlugin, SpincastHttpCachingPlugin, SpincastHttpClientPlugin, SpincastHttpClientWithWebsocketPlugin, SpincastJacksonJsonPlugin, SpincastJacksonXmlPlugin, SpincastLocaleResolverPlugin, SpincastPebblePlugin, SpincastPluginBase, SpincastRequestPlugin, SpincastResponsePlugin, SpincastRoutingPlugin, SpincastTemplatingAddonPlugin, SpincastUndertowPlugin, SpincastVariablesPlugin

public interface SpincastPlugin
extends SpincastContextTypesInterested

Method Summary

Modifier and Type	Method and Description
com.google.inject.Module	apply(com.google.inject.Module currentModule) Applies the plugin.
void	createdGuiceInjector(com.google.inject.Injector injector) Once all the plugins have been applied, this method is called with the resulting Guice injector.
String	getId() The id of the plugin.
Set<String>	getPluginsToDisable() If required, the ids of plugins that shouldn't be installed.
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.

Method Detail

getId

String getId()

The id of the plugin.

apply

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

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.

Returns:

an ajusted Guice module.

setRequestContextImplementationClass

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

The implementation class to use for RequestContext.

Specified by:

setRequestContextImplementationClass in interface SpincastContextTypesInterested

setWebsocketContextImplementationClass

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

The implementation class to use for WebsocletContext.

Specified by:

setWebsocketContextImplementationClass in interface SpincastContextTypesInterested

getPluginsToDisable

Set<String> getPluginsToDisable()

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.

createdGuiceInjector

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

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