public.javadoc.org.spincast.core.guice.SpincastPluginBase.html Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation
Show all versions of spincast-website Show documentation
Source code for the https://www.spincast.org website.
SpincastPluginBase (org.spincast:spincast-framework 1.0.0 API)
org.spincast.core.guice
Class SpincastPluginBase
- java.lang.Object
-
- org.spincast.core.guice.SpincastPluginBase
-
- All Implemented Interfaces:
- SpincastContextTypesInterested, SpincastPlugin
- Direct Known Subclasses:
- SpincastAttemptsLimiterPlugin, SpincastConfigPlugin, SpincastCorePlugin, SpincastCryptoPlugin, SpincastDateFormatterPlugin, SpincastDictionaryPlugin, SpincastFlywayUtilsPlugin, SpincastFormsProtectionPlugin, SpincastHotSwapPlugin, SpincastHttpCachingPlugin, SpincastHttpClientPlugin, SpincastJacksonJsonPlugin, SpincastJacksonXmlPlugin, SpincastJdbcPlugin, SpincastLocaleResolverPlugin, SpincastPebblePlugin, SpincastRequestPlugin, SpincastResponsePlugin, SpincastRoutingPlugin, SpincastScheduledTasksPlugin, SpincastSessionPlugin, SpincastTemplatingAddonPlugin, SpincastTimeZoneResolverPlugin, SpincastUndertowPlugin, SpincastVariablesPlugin, SpincastWatermarkerPlugin
public abstract class SpincastPluginBase
extends Object
implements SpincastPlugin
Suggested base class for a Spincast plugin.
-
-
Constructor Summary
Constructors
Constructor and Description
SpincastPluginBase()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
void
createdGuiceInjector(com.google.inject.Injector injector)
Once all the plugins have been applied,
this method is called with the resulting
Guice injector.
Set<String>
getPluginsToDisable()
If required, the ids of plugins that shouldn't
be installed.
protected Class<? extends RequestContext<?>>
getRequestContextImplementationClass()
protected Class<? extends WebsocketContext<?>>
getWebsocketContextImplementationClass()
protected void
setContextTypes(com.google.inject.Module module)
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
-
Methods inherited from interface org.spincast.core.guice.SpincastPlugin
apply, getId
-
-
Method Detail
-
setRequestContextImplementationClass
public void setRequestContextImplementationClass(Class<? extends RequestContext<?>> requestContextImplementationClass)
Description copied from interface: SpincastContextTypesInterested
The implementation class to use for RequestContext.
- Specified by:
setRequestContextImplementationClass
in interface SpincastContextTypesInterested
-
setWebsocketContextImplementationClass
public void setWebsocketContextImplementationClass(Class<? extends WebsocketContext<?>> websocketContextImplementationClass)
Description copied from interface: SpincastContextTypesInterested
The implementation class to use for WebsocletContext.
- Specified by:
setWebsocketContextImplementationClass
in interface SpincastContextTypesInterested
-
getRequestContextImplementationClass
protected Class<? extends RequestContext<?>> getRequestContextImplementationClass()
-
getWebsocketContextImplementationClass
protected Class<? extends WebsocketContext<?>> getWebsocketContextImplementationClass()
-
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
-
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
-
setContextTypes
protected void setContextTypes(com.google.inject.Module module)
Copyright © 2019. All rights reserved.