io.stallion.boot

Interface StallionRunAction<T extends CommandOptionsBase>

Type Parameters:

T -

All Known Implementing Classes:

ExportToHtml, ForceTaskAction, InteractiveJavascriptRunAction, NewDraftPageAction, NewJavaPluginRunAction, NewProjectBuilder, PluginTestsRunAction, ScriptExecBase, SecretsAction, SecretsDecryptAction, SqlCheckNeedsMigrationAction, SqlGenerationAction, SqlMigrationAction, StallionServer, UserAdder, WorkerCommandAction

public interface StallionRunAction<T extends CommandOptionsBase>

A way to implement executable actions that can be run via the command line. When you run Stallion from the command line you pass in an action as the first argument, such as "serve" or "new". Each action implements this interface, and then is added to the list of actions in io.stallion.Booter.

Method Summary

Modifier and Type	Method and Description
void	execute(T options) Actually do the action.
String	getActionName() The name of the action, will be used on the command line to run the action.
String	getHelp() A friendly description of what the action does, will be printed on the command-line when help is asked for.
default String	getSubActionName()
void	loadApp(T options) Load the application context.
default <T extends CommandOptionsBase> T	newCommandOptions() Each action might have its own command-line arguments.

Method Detail

getActionName

String getActionName()

The name of the action, will be used on the command line to run the action.

Returns:

getHelp

String getHelp()

A friendly description of what the action does, will be printed on the command-line when help is asked for.

Returns:

loadApp

void loadApp(T options)

Load the application context. Some actions just need the settings loaded. Other actions need the settings plus all the services and data access layers. Other actions need all the former plus need to start jobs and the async task coordinator. Call exactly what you need to load in this method.

Parameters:

options -

getSubActionName

default String getSubActionName()

newCommandOptions

default <T extends CommandOptionsBase> T newCommandOptions()

Each action might have its own command-line arguments. Define your command-line arguments by creating a subclass of BaseCommandOptions. Then override this method to construct an instance of the subclass you created and return it.

Type Parameters:

T -

Returns:

execute

void execute(T options)
      throws Exception

Actually do the action.

Parameters:

options -

Throws:

Exception