public interface Response
Modifier and Type | Interface and Description |
---|---|
static class |
Response.Status |
Modifier and Type | Method and Description |
---|---|
void |
setContinue(String nextCommand)
This method will continue the configuration or execution of the
job with a new command to the plugin.
|
void |
setDone(String message)
This will end the job execution and report it as a success.
|
void |
setDone(String message,
Job.ExecutionTime estimatedExecutionTime)
This will end the configuration of a job and set the estimated
execution time for it.
|
void |
setDownloadImmediately(String message,
Job.ExecutionTime estimatedExecutionTime,
boolean failIfDenied)
This will end the configuration of a export job, and start to execute it
for immediate download.
|
void |
setDryRun(boolean dryRun)
A plug-in may call this method in it's configuration phase or
after it has been executed to indicate that the job should be
or was executed as a dry-run job.
|
void |
setError(String message,
List<? extends Throwable> errorList)
This will end the job execution or configuration and report it as a
failure.
|
void |
setExecuteImmediately(String message,
Job.ExecutionTime estimatedExecutionTime,
boolean failIfDenied)
This will end the configuration of a job, and start to execute it
immediately if the plugin is permitted to do so.
|
void |
setSuggestedJobName(String jobName)
A plug-in may call this method on it's job configuration phase
to suggest a name for the job.
|
void setContinue(String nextCommand) throws PermissionDeniedException
Signal.SHUTDOWN
signal.nextCommand
- The next command to the pluginPermissionDeniedException
- If another command isn't allowedvoid setDone(String message, Job.ExecutionTime estimatedExecutionTime)
message
- An optional messageestimatedExecutionTime
- An estimated execution time for the job,
null is the same as ExecutionTime.LONG
void setExecuteImmediately(String message, Job.ExecutionTime estimatedExecutionTime, boolean failIfDenied) throws PermissionDeniedException
failIfDenied
flag is set to true,
in which case an exception will be thrown.
If immediate execution is possible the client application must continue to use the same instance of the plugin object. This means that immediate execution always happens in the same virtual machine. Plugins should be aware of this and avoid excessive use of resources such as memory and CPU time.
The client application may execute the job in another thread.
message
- An optional messageestimatedExecutionTime
- An estimated execution time for the job,
null is the same as ExecutionTime.LONG
. This value is only used
if immediate execution isn't possible and the job has to be added to the
job queue.failIfDenied
- TRUE if a PermissionDeniedException should be thrown if
immediate exection isn't possible, FALSE to add the job to the job queue
for later exectionPermissionDeniedException
- If logged in user doesn't have write permission on the job.void setDownloadImmediately(String message, Job.ExecutionTime estimatedExecutionTime, boolean failIfDenied) throws PermissionDeniedException
setExecuteImmediately(String, Job.ExecutionTime, boolean)
but:
ImmediateDownloadExporter
interface.
ImmediateDownloadExporter.doExport(ExportOutputStream, ProgressReporter)
instead of the Plugin.run(Request, Response, ProgressReporter)
method.
message
- An optional messageestimatedExecutionTime
- An estimated execution time for the job,
null is the same as ExecutionTime.LONG
. This value is only used
if immediate execution isn't possible and the job has to be added to the
job queue.failIfDenied
- TRUE if a PermissionDeniedException should be thrown if
immediate exection isn't possible, FALSE to add the job to the job queue
for later exectionPermissionDeniedException
- If the logged in user doesn't have write permission to the job.void setDone(String message)
message
- A message containing any relevant information about
what the plugin did, or nullvoid setDryRun(boolean dryRun)
NOTE! Setting this value to true doesn't change the behaviour
of the core. It is the responsibility of the plug-in to check
this value(eg. Job.isDryRun()
and take appropriate action.
dryRun
- TRUE to indicate that the job should be or was
executed as a dry-runvoid setSuggestedJobName(String jobName)
void setError(String message, List<? extends Throwable> errorList)
message
- Information about the reason for the errorerrorList
- Detailed information about the error