public.javadoc.org.spincast.core.guice.SpincastPlugin.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastPlugin (org.spincast:spincast-framework 1.0.0 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.core.guice
Interface SpincastPlugin






All Superinterfaces:
SpincastContextTypesInterested


All Known Implementing Classes:
GuiceTweaker, SpincastAttemptsLimiterPlugin, SpincastConfigPlugin, SpincastCorePlugin, SpincastCryptoPlugin, SpincastDateFormatterPlugin, SpincastDictionaryPlugin, SpincastFlywayUtilsPlugin, SpincastFormsProtectionPlugin, SpincastHotSwapPlugin, SpincastHttpCachingPlugin, SpincastHttpClientPlugin, SpincastHttpClientWithWebsocketPlugin, SpincastJacksonJsonPlugin, SpincastJacksonXmlPlugin, SpincastJdbcPlugin, SpincastLocaleResolverPlugin, SpincastPebblePlugin, SpincastPluginBase, SpincastRequestPlugin, SpincastResponsePlugin, SpincastRoutingPlugin, SpincastScheduledTasksPlugin, SpincastSessionPlugin, SpincastTemplatingAddonPlugin, SpincastTimeZoneResolverPlugin, SpincastUndertowPlugin, SpincastVariablesPlugin, SpincastWatermarkerPlugin




public interface SpincastPlugin
extends SpincastContextTypesInterested











Method Summary

All Methods Instance Methods Abstract Methods 

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.







Methods inherited from interface org.spincast.core.guice.SpincastContextTypesInterested
setRequestContextImplementationClass, setWebsocketContextImplementationClass














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.








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.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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.