2.17.2: 2011-06-17

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

java.lang.Object
  extended by net.sf.basedb.plugins.executor.ExternalProgramExecutor.RequestWrapper
All Implemented Interfaces:
Request
Enclosing class:
ExternalProgramExecutor

static class ExternalProgramExecutor.RequestWrapper
extends Object
implements Request


Field Summary
private  String command
           
private  Map<String,Object> parameters
           
private  Request parent
           
 
Fields inherited from interface net.sf.basedb.core.plugin.Request
COMMAND_CONFIGURE_JOB, COMMAND_CONFIGURE_PLUGIN, COMMAND_EXECUTE
 
Constructor Summary
ExternalProgramExecutor.RequestWrapper(String command, Request parent)
           
 
Method Summary
 String getCommand()
          The command the plugin should execute.
 Object getParameterValue(String name)
          Get the value for the parameter with the specified name.
 List<?> getParameterValues(String name)
          Get the values for the parameter with the specified name.
 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 Detail

command

private final String command

parent

private final Request parent

parameters

private final Map<String,Object> parameters
Constructor Detail

ExternalProgramExecutor.RequestWrapper

ExternalProgramExecutor.RequestWrapper(String command,
                                       Request parent)
Method Detail

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

getParameterValue

public Object 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 List<?> 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

2.17.2: 2011-06-17