Package net.sf.basedb.core

Class PluginRequest.RequestImpl

java.lang.Object

net.sf.basedb.core.PluginRequest.RequestImpl

All Implemented Interfaces:

Request

Enclosing class:

PluginRequest<P extends Plugin>

class PluginRequest.RequestImpl
extends Object
implements Request

An implementation of the Request interface that is passed to the plugin.

Field Summary

Fields

Modifier and Type	Field	Description
private final boolean	allowImmediateExecution

Fields inherited from interface net.sf.basedb.core.plugin.Request

COMMAND_CONFIGURE_JOB, COMMAND_CONFIGURE_PLUGIN, COMMAND_EXECUTE

Constructor Summary

Constructors

Constructor	Description
RequestImpl(boolean allowImmediateExecution)

Method Summary

Modifier and Type	Method	Description
String	getCommand()	The command the plugin should execute.
<T> T	getParameterValue(String name)	Get the value for the parameter with the specified name.
<T> List<T>	getParameterValues(String name)	Get the values for the parameter with the specified name.
Serializable	getState()	Get state information that was previously saved by Response.setPause(String, String, java.io.Serializable) or Response.setContinue(String, java.io.Serializable).
boolean	isAllowedImmediateExecution()	If this plugin has been allowed immediate execution or not.

Methods inherited from class java.lang.Object

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

Field Details

allowImmediateExecution

private final boolean allowImmediateExecution

Constructor Details

RequestImpl

RequestImpl(boolean allowImmediateExecution)

Method Details

getCommand

public String getCommand()

Description copied from interface: Request

The command the plugin should execute. This value is one of the predefined constants above, or some other value that is supported by the specific plugin.

Specified by:

getCommand in interface Request

getState

public Serializable getState()

Description copied from interface: Request

Get state information that was previously saved by Response.setPause(String, String, java.io.Serializable) or Response.setContinue(String, java.io.Serializable).

Specified by:

getState in interface Request

Returns:

The state information or null

getParameterValue

public <T> T getParameterValue(String name)

Description copied from interface: Request

Get the value for the parameter with the specified name.

Specified by:

getParameterValue in interface Request

Parameters:

name - The name of the parameter

Returns:

An object with the value, or null if no value is given

getParameterValues

public <T> List<T> getParameterValues(String name)

Description copied from interface: Request

Get the values for the parameter with the specified name.

Specified by:

getParameterValues in interface Request

Parameters:

name - The name of the parameter

Returns:

An object with the value, or null if no value is given

isAllowedImmediateExecution

public boolean isAllowedImmediateExecution()

Description copied from interface: Request

If this plugin has been allowed immediate execution or not. If this is true the plugin may end a job configuration sequence with Response.setExecuteImmediately(String, Job.ExecutionTime, boolean) or, if the plugin is a ImmediateDownloadExporter, Response.setDownloadImmediately(String, Job.ExecutionTime, boolean).

Specified by:

isAllowedImmediateExecution in interface Request

Returns:

TRUE if it is allowed, FALSE otherwise