io.swagger.api.data

Class TaskHandler

java.lang.Object

io.swagger.api.data.TaskHandler

All Implemented Interfaces:

Runnable

public abstract class TaskHandler
extends Object
implements Runnable

TaskHandler class to execute background tasks

To execute long running jobs use TaskHandler class to run and control threads.
Asynchronous jobs are handled via the TaskHandler class. Task data is stored in Task class.
Example:

 
 TaskHandler task = new TaskHandler(TaskTest.class.toString(), "Task name", "The task description", "http://0.0.0.0:8081/") {
      @Override
      public void run() {
          try {
              // here comes the code to run
              finish(); //saves task to COMPLETED, SAVED and 100%
          } catch (YourException e) {
              e.printStackTrace();
          }
      }
  };

 task.start(); //run the task

 
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskHandler(String creator, String title, String description, String baseuri)

Method Summary

Modifier and Type	Method and Description
void	cancel() To cancel a task after it was started interupts thread and set hasStatus to Task.Status.CANCELLED
void	delete() Delete task in mongodb
void	finish() Call at end of task to set percentageCompleted = 100, hasStatus = Task.Status.CANCELLED, step = Task.Step.SAVED update task in mongodb
Date	getDate()
String	getDescription()
ErrorReport	getErrorReport()
Float	getPercentageCompleted()
String	getResultURI()
Task.Status	getStatus()
Task.Step	getStep()
String	getTaskID()
String	getTitle()
String	getURI()
void	setDescription(String description)
protected void	setErrorReport(Exception e, Integer http_code, String actor) Create an error report for a failed task
void	setPercentageCompleted(Float percentageCompleted)
protected void	setResultURI(String resultURI)
void	setState(Task.Step step, float percentageComplete)
void	setStatus(Task.Status status)
void	setTaskID(String id)
void	setTitle(String title)
void	setURI(String URI)
void	start() Starts task, set hasStatus to RUNNING and percentageCompleted to 0 saves the Task task to mongodb

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

TaskHandler

protected TaskHandler(String creator,
                      String title,
                      String description,
                      String baseuri)

Parameters:

creator - name of the creator (e.g.: service or user)

title - task title

description - description

baseuri - base URI of the webservice

Method Detail

start

public void start()

Starts task, set hasStatus to RUNNING and percentageCompleted to 0 saves the Task task to mongodb

setState

public void setState(Task.Step step,
                     float percentageComplete)

cancel

public void cancel()

To cancel a task after it was started interupts thread and set hasStatus to Task.Status.CANCELLED

finish

public void finish()

Call at end of task to set percentageCompleted = 100, hasStatus = Task.Status.CANCELLED, step = Task.Step.SAVED update task in mongodb

getURI

public String getURI()

setURI

public void setURI(String URI)

getStatus

public Task.Status getStatus()

setStatus

public void setStatus(Task.Status status)

getDate

public Date getDate()

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getPercentageCompleted

public Float getPercentageCompleted()

setPercentageCompleted

public void setPercentageCompleted(Float percentageCompleted)

getStep

public Task.Step getStep()

getResultURI

public String getResultURI()

setResultURI

protected void setResultURI(String resultURI)

getTaskID

public String getTaskID()

setTaskID

public void setTaskID(String id)

getErrorReport

public ErrorReport getErrorReport()

setErrorReport

protected void setErrorReport(Exception e,
                              Integer http_code,
                              String actor)

Create an error report for a failed task

Parameters:

e - Exception

http_code - http code

actor - calling method

delete

public void delete()

Delete task in mongodb