|
2.8.3: 2008-10-15 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.basedb.core.PluginResponse
public final class PluginResponse
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.
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
|
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. |
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. |
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 |
---|
private final PluginConfigurationRequest request
private final Response response
private final boolean allowImmediateExecution
private final boolean allowImmediateDownload
private Response.Status status
private Job.ExecutionTime estimatedExecutionTime
private String message
private boolean dryRun
private List<? extends Throwable> errorList
private String nextCommand
Constructor Detail |
---|
PluginResponse(PluginConfigurationRequest request, boolean allowImmediateExection, boolean allowImmediateDownload, boolean dryRun)
Method Detail |
---|
public Response.Status getStatus()
public boolean isDryRun()
public String getMessage()
public Job.ExecutionTime getEstimatedExecutionTime()
public List<? extends Throwable> getErrorList()
Response.Status.ERROR
.
getMessage()
public PluginConfigurationRequest getNextRequest()
PluginRequest
object that handles the next request,
if status is Response.Status.CONTINUE
.
public PluginExecutionRequest getExecutionRequest(ProgressReporter progress) throws PermissionDeniedException
PermissionDeniedException
public void saveParameters(DbControl dc)
dc
- An open DbControl to use when accessing the database.public void downloadImmediately(ExportOutputStream out, ProgressReporter progress) throws IOException
IOException
Response getResponseImpl()
PluginRequest.invoke()
method.
void setError(String message, Throwable t)
private void reset(Response.Status status)
|
2.8.3: 2008-10-15 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |