Package org.spincast.core.guice

Interface SpincastPlugin

All Superinterfaces:

SpincastContextTypesInterested

All Known Implementing Classes:

GuiceTweaker, SpincastAttemptsLimiterPlugin, SpincastConfigPlugin, SpincastCorePlugin, SpincastCryptoPlugin, SpincastCssAutoprefixerPlugin, SpincastCssYuiCompressorPlugin, SpincastDateFormatterPlugin, SpincastDictionaryPlugin, SpincastFlywayUtilsPlugin, SpincastFormsProtectionPlugin, SpincastGsonPlugin, SpincastHotSwapPlugin, SpincastHttpCachingPlugin, SpincastHttpClientPlugin, SpincastHttpClientWithWebsocketPlugin, SpincastJacksonJsonPlugin, SpincastJacksonXmlPlugin, SpincastJdbcPlugin, SpincastJsClosureCompilerPlugin, SpincastLocaleResolverPlugin, SpincastLogbackUtilsPlugin, SpincastOpenApiBottomUpPlugin, SpincastPebblePlugin, SpincastPluginBase, SpincastProcessUtilsPlugin, SpincastRequestPlugin, SpincastResponsePlugin, SpincastRoutingPlugin, SpincastScheduledTasksPlugin, SpincastSessionPlugin, SpincastSwaggerUiPlugin, SpincastTemplatingAddonPlugin, SpincastTimeZoneResolverPlugin, SpincastUndertowPlugin, SpincastVariablesPlugin, SpincastWatermarkerPlugin

public interface SpincastPlugin
extends SpincastContextTypesInterested

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface org.spincast.core.guice.SpincastContextTypesInterested

setRequestContextImplementationClass, setWebsocketContextImplementationClass

Method Details

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.

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 marks 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.