net.sf.basedb.core
Class PluginResponse

java.lang.Object
  net.sf.basedb.core.PluginResponse

public final class PluginResponse
extends Object

Get the response from a configuration step or execution of a plugin. Use getStatus() to find out the status of the last invokation. See PluginRequest for more information.

Version:

2.0

Author:

Nicklas

Last modified

$Date$

Nested Class Summary

private class

PluginResponse.ResponseImpl An implementation of the Response interface used by the plugin to return information to the client.

Field Summary

private boolean	allowImmediateDownload
private boolean	allowImmediateExecution
private boolean	dryRun
private List<? extends Throwable>	errorList
private Job.ExecutionTime	estimatedExecutionTime
private String	message
private String	nextCommand
private PluginConfigurationRequest	request
private Response	response
private Response.Status	status
private String	suggestedJobName

Constructor Summary

PluginResponse(PluginConfigurationRequest request, boolean allowImmediateExection, boolean allowImmediateDownload, boolean dryRun)

Method Summary

void	downloadImmediately(ExportOutputStream out, ProgressReporter progress)
List<? extends Throwable>	getErrorList() Get a list containing detailed error messages if the status is Response.Status.ERROR.
Job.ExecutionTime	getEstimatedExecutionTime() Get the estimated execution time of the job.
PluginExecutionRequest	getExecutionRequest(ProgressReporter progress)
String	getMessage() Get the return message from the plugin.
String	getNextCommand() Get the next command sent via Response.Status.CONTINUE.
PluginConfigurationRequest	getNextRequest() Get a PluginRequest object that handles the next request, if status is Response.Status.CONTINUE.
(package private) Response	getResponseImpl() Get a new reponse object.
Response.Status	getStatus() Get the status of the response.
String	getSuggestedJobName() Get the job name that was suggested by the job.
boolean	isDryRun() Check if the job should be executed or was executed in dry-run mode.
private void	reset(Response.Status status)
void	saveParameters(DbControl dc) Save all parameters that has been configured during the configuration sequence to the database.
(package private) void	setError(String message, Throwable t) Set a singe error message.

Methods inherited from class java.lang.Object

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

Field Detail

request

private final PluginConfigurationRequest request

response

private final Response response

allowImmediateExecution

private final boolean allowImmediateExecution

allowImmediateDownload

private final boolean allowImmediateDownload

status

private Response.Status status

estimatedExecutionTime

private Job.ExecutionTime estimatedExecutionTime

message

private String message

dryRun

private boolean dryRun

suggestedJobName

private String suggestedJobName

errorList

private List<? extends Throwable> errorList

nextCommand

private String nextCommand

Constructor Detail

PluginResponse

PluginResponse(PluginConfigurationRequest request,
               boolean allowImmediateExection,
               boolean allowImmediateDownload,
               boolean dryRun)

Method Detail

getStatus

public Response.Status getStatus()

Get the status of the response.

isDryRun

public boolean isDryRun()

Check if the job should be executed or was executed in dry-run mode.

Since:

2.8

getSuggestedJobName

public String getSuggestedJobName()

Get the job name that was suggested by the job.

Returns:

A job name or null if no name has been suggested

Since:

2.17

getMessage

public String getMessage()

Get the return message from the plugin.

getEstimatedExecutionTime

public Job.ExecutionTime getEstimatedExecutionTime()

Get the estimated execution time of the job. This value is only meaningful after a successful configuration sequence for a job.

getErrorList

public List<? extends Throwable> getErrorList()

Get a list containing detailed error messages if the status is Response.Status.ERROR.

See Also:

getMessage()

getNextCommand

public String getNextCommand()

Get the next command sent via Response.Status.CONTINUE.

Returns:

The next command or null

Since:

2.16

getNextRequest

public PluginConfigurationRequest getNextRequest()

Get a PluginRequest object that handles the next request, if status is Response.Status.CONTINUE.

getExecutionRequest

public PluginExecutionRequest getExecutionRequest(ProgressReporter progress)
                                           throws PermissionDeniedException

Throws:

PermissionDeniedException

saveParameters

public void saveParameters(DbControl dc)

Save all parameters that has been configured during the configuration sequence to the database.

Parameters:

dc - An open DbControl to use when accessing the database.

downloadImmediately

public void downloadImmediately(ExportOutputStream out,
                                ProgressReporter progress)
                         throws IOException

Throws:

IOException

getResponseImpl

Response getResponseImpl()

Get a new reponse object. Used by the PluginRequest.invoke() method.

setError

void setError(String message,
              Throwable t)

Set a singe error message.

reset

private void reset(Response.Status status)