Package net.sf.basedb.plugins.executor

Class ExternalProgramExecutor.RequestWrapper

java.lang.Object

net.sf.basedb.plugins.executor.ExternalProgramExecutor.RequestWrapper

All Implemented Interfaces:

Request

Enclosing class:

ExternalProgramExecutor

static class ExternalProgramExecutor.RequestWrapper
extends Object
implements Request

Field Summary

Fields

Modifier and Type	Field	Description
private final String	command
private final Map<String,Object>	parameters
private final Request	parent

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

COMMAND_CONFIGURE_JOB, COMMAND_CONFIGURE_PLUGIN, COMMAND_EXECUTE

Constructor Summary

Constructors

Constructor	Description
RequestWrapper(String command, Request parent)

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.
(package private) void	setParameter(String key, Object value)

Methods inherited from class java.lang.Object

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

Field Details

command

private final String command

parent

private final Request parent

parameters

private final Map<String,Object> parameters

Constructor Details

RequestWrapper

RequestWrapper(String command,
 Request parent)

Method Details

setParameter

void setParameter(String key,
 Object value)

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)
                        throws ParameterException

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

Throws:

ParameterException - If getting the value fails.

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