Package net.sf.basedb.core
Class PluginRequest<P extends Plugin>
java.lang.Object
net.sf.basedb.core.PluginRequest<P>
- Direct Known Subclasses:
PluginConfigurationRequest
,PluginExecutionRequest
Configures or executes a plugin. You will get an instance of
a subclass to this class when:
- You want to configure a plugin:
PluginConfiguration.configure()
- You want to configure a job:
Job.configure(GuiContext)
- You want to execute a job:
Job.execute(ProgressReporter, String)
- Version:
- 2.0
- Author:
- Nicklas
- See Also:
- Last modified
- $Date$
-
Nested Class Summary
Modifier and TypeClassDescription(package private) class
An implementation of theRequest
interface that is passed to the plugin. -
Field Summary
Modifier and TypeFieldDescriptionprivate String
private final ParameterValuesImpl
private final Job
private final ParameterValuesImpl
private final Map<String,
PluginParameter<?>> private final P
private final PluginConfiguration
private final PluginDefinition
private final SessionControl
private final Serializable
-
Constructor Summary
ConstructorDescriptionPluginRequest
(PluginRequest<? extends P> copyFrom, String command) PluginRequest
(SessionControl sc, P plugin, String command, PluginConfiguration pluginConfiguration, ParameterValuesImpl configurationParameters, Job job, ParameterValuesImpl jobParameters, PluginDefinition pluginDefinition) -
Method Summary
Modifier and TypeMethodDescriptionvoid
done()
Aborts the execution of the plugin.Get the command this request will issue to the plugin wheninvoke()
is called.List<?>
Get the values that are currently stored in the plugin configuration related to this request.List<?>
Get the values that are currently stored in the job related to this request.List<?>
Get the values that are currently stored in the job or plugin configuration related to this request.(package private) Job
getJob()
Get the job for the request or null if we are not configuring/executing a job.Get the plugin object.abstract PluginResponse
invoke()
Invoke the plugin and let it do it's work.(package private) void
registerParameters
(List<PluginParameter<?>> parameters) Keep track of all parameters so that we can save label and description in theParameterValuesImpl.saveParameters(Job, Map)
method.(package private) void
saveParameters
(DbControl dc, GuiContext context) Save all parameters that have got values in this request/response session.(package private) void
setNextCommand
(String command) Sets the next command in a configuration sequence.void
setParameterValue
(String name, Object value) Set the value of a request parameter to a single value.void
setParameterValues
(String name, List<?> values) Set the value of a request parameter to a list of values.
-
Field Details
-
sc
-
command
-
state
-
requestParameters
-
plugin
-
configurationParameters
-
pluginConfiguration
-
pluginDefinition
-
jobParameters
-
parameterInfo
-
job
-
-
Constructor Details
-
PluginRequest
PluginRequest(SessionControl sc, P plugin, String command, PluginConfiguration pluginConfiguration, ParameterValuesImpl configurationParameters, Job job, ParameterValuesImpl jobParameters, PluginDefinition pluginDefinition) -
PluginRequest
PluginRequest(PluginRequest<? extends P> copyFrom, String command)
-
-
Method Details
-
getSessionControl
- Returns:
- The SessionControl used in this request
- Since:
- 2.11
-
getCommand
Get the command this request will issue to the plugin wheninvoke()
is called. -
setParameterValue
Set the value of a request parameter to a single value. Normally a plugin validates the value using the information available in theRequestInformation
object.- Parameters:
name
- The name of the parametervalue
- The value of the parameter- See Also:
-
setParameterValues
Set the value of a request parameter to a list of values. Normally a plugin validates the value using the information available in theRequestInformation
object.- Parameters:
name
- The name of the parametervalues
- The values of the parameter- See Also:
-
getCurrentParameterValue
-
getCurrentParameterValues
Get the values that are currently stored in the job or plugin configuration related to this request. This method will first check the job and then the plugin configuration.- Parameters:
name
- The name of the parameter- Returns:
- The parameter values, or null if no parameter with the given name exists
-
getCurrentConfigurationParameterValues
Get the values that are currently stored in the plugin configuration related to this request.- Parameters:
name
- The name of the parameter- Returns:
- The parameter values, or null if no parameter with the given name exists or if this request isn't associated with a plugin configuration
-
getCurrentJobParameterValues
Get the values that are currently stored in the job related to this request.- Parameters:
name
- The name of the parameter- Returns:
- The parameter values, or null if no parameter with the given name exists or if this request isn't associated with a job
-
invoke
Invoke the plugin and let it do it's work. Note that this method doesn't throw any exceptions. If an exception occurs during the execution of a plugin, the response status will be set toResponse.Status.ERROR
and the error messages will be available in thePluginResponse.getMessage()
andPluginResponse.getErrorList()
methods.- Returns:
- A
PluginResponse
object
-
done
public void done()Aborts the execution of the plugin. -
registerParameters
Keep track of all parameters so that we can save label and description in theParameterValuesImpl.saveParameters(Job, Map)
method. -
saveParameters
Save all parameters that have got values in this request/response session. -
setNextCommand
Sets the next command in a configuration sequence. -
getPlugin
Get the plugin object.- Since:
- 2.6 (was not public before)
-
getJob
Job getJob()Get the job for the request or null if we are not configuring/executing a job.- Since:
- 2.2
-