io.stallion.boot

Class ForceTaskAction

java.lang.Object

io.stallion.boot.ForceTaskAction

All Implemented Interfaces:

StallionRunAction<ForceActionOptions>

public class ForceTaskAction
extends Object
implements StallionRunAction<ForceActionOptions>

Constructor Summary

Constructors

Constructor and Description
ForceTaskAction()

Method Summary

Modifier and Type	Method and Description
void	execute(ForceActionOptions 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.
void	loadApp(ForceActionOptions options) Load the application context.
ForceActionOptions	newCommandOptions() Each action might have its own command-line arguments.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.stallion.boot.StallionRunAction

getSubActionName

Constructor Detail

ForceTaskAction

public ForceTaskAction()

Method Detail

getActionName

public String getActionName()

Description copied from interface: StallionRunAction

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

Specified by:

getActionName in interface StallionRunAction<ForceActionOptions>

Returns:

getHelp

public String getHelp()

Description copied from interface: StallionRunAction

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

Specified by:

getHelp in interface StallionRunAction<ForceActionOptions>

Returns:

loadApp

public void loadApp(ForceActionOptions options)

Description copied from interface: StallionRunAction

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.

Specified by:

loadApp in interface StallionRunAction<ForceActionOptions>

newCommandOptions

public ForceActionOptions newCommandOptions()

Description copied from interface: StallionRunAction

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.

Specified by:

newCommandOptions in interface StallionRunAction<ForceActionOptions>

Returns:

execute

public void execute(ForceActionOptions options)
             throws Exception

Description copied from interface: StallionRunAction

Actually do the action.

Specified by:

execute in interface StallionRunAction<ForceActionOptions>

Throws:

Exception