io.stallion.plugins

Class StallionJavaPlugin

java.lang.Object

io.stallion.plugins.StallionJavaPlugin

public abstract class StallionJavaPlugin
extends Object

Constructor Summary

Constructors

Constructor and Description
StallionJavaPlugin()

Method Summary

Modifier and Type	Method and Description
abstract void	boot() The main method that gets called to load the plugin -- do everything here, such as loading controllers, loading endpoints, etc.
void	bootForPackage(String packagePath)
void	commandlineConfigure() Override this to implement configuring this plugin via the command-line.
List<? extends StallionRunAction>	getActions() Get a list of available actions
abstract String	getPluginName()
List<String>	getSqlMigrations()
void	setPluginRegistry(PluginRegistry pluginRegistry)
void	shutdown() Override this to shutdown services when the Stallion AppContext shutsdown
void	startServices() This gets called after plugin load, when Stallion is running as an actual web server.
void	startServicesForTests() Called by AppContextLoader.startServicesForTests(), which is called when loading an app context via the BaseIntegrationTestCase JUnit test case base class.

Methods inherited from class java.lang.Object

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

Constructor Detail

StallionJavaPlugin

public StallionJavaPlugin()

Method Detail

getPluginName

public abstract String getPluginName()

getSqlMigrations

public List<String> getSqlMigrations()

getActions

public List<? extends StallionRunAction> getActions()

Get a list of available actions

Returns:

commandlineConfigure

public void commandlineConfigure()

Override this to implement configuring this plugin via the command-line.

boot

public abstract void boot()
                   throws Exception

The main method that gets called to load the plugin -- do everything here, such as loading controllers, loading endpoints, etc.

Throws:

Exception

startServices

public void startServices()

This gets called after plugin load, when Stallion is running as an actual web server. Specifically, this gets called by AppContextLoader.startAllServices(). Override this if there are background services that do not need to be run when executing most Stallion actions, but do need to be run when running a script action.

startServicesForTests

public void startServicesForTests()

Called by AppContextLoader.startServicesForTests(), which is called when loading an app context via the BaseIntegrationTestCase JUnit test case base class.

shutdown

public void shutdown()

Override this to shutdown services when the Stallion AppContext shutsdown

bootForPackage

public void bootForPackage(String packagePath)

setPluginRegistry

public void setPluginRegistry(PluginRegistry pluginRegistry)