Package org.texttechnologylab.duui.api.routes.processes

Klasse DUUIProcessRequestHandler

java.lang.Object

org.texttechnologylab.duui.api.routes.processes.DUUIProcessRequestHandler

public class DUUIProcessRequestHandler
extends Object

A class that is responsible for handling incoming requests to the /processes path group.

Autor:

Cedric Borkowksi

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
DUUIProcessRequestHandler()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static String	deleteOne(spark.Request request, spark.Response response)	Delete a process given its id.
static String	findDocuments(spark.Request request, spark.Response response)	Retrieve a limited number of documents from the database.
static String	findEvents(spark.Request request, spark.Response response)	Retrieve events associated with the process.
static String	findMany(spark.Request request, spark.Response response)	Retrieve a process given its id.
static String	findOne(spark.Request request, spark.Response response)	Retrieve a process given its id.
static String	getFolderStructure(spark.Request request, spark.Response response)	Retrieve the folder structure of a provider.
static String	start(spark.Request request, spark.Response response)	Create and start a new process.
static String	stop(spark.Request request, spark.Response response)	Cancel a process that is currently running.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

DUUIProcessRequestHandler

public DUUIProcessRequestHandler()

Methodendetails

getFolderStructure

public static String getFolderStructure(spark.Request request,
 spark.Response response)
                                 throws com.dropbox.core.DbxException,
ExecutionException,
InterruptedException,
GeneralSecurityException,
IOException

Retrieve the folder structure of a provider. See IDUUIFolderPickerApi.getFolderStructure().

Gibt zurück:

A JSON Document containing the folder structure.

Löst aus:

com.dropbox.core.DbxException

ExecutionException

InterruptedException

GeneralSecurityException

IOException

findOne

public static String findOne(spark.Request request,
 spark.Response response)

Retrieve a process given its id. See DUUIProcessController.findOneById(String)

Gibt zurück:

A response containing the process or a default not found (404).

findMany

public static String findMany(spark.Request request,
 spark.Response response)

Retrieve a process given its id. See DUUIProcessController.findMany(MongoDBFilters)

Gibt zurück:

A response containing the processes or a default not found (404).

deleteOne

public static String deleteOne(spark.Request request,
 spark.Response response)

Delete a process given its id. See DUUIProcessController.deleteOne(String)

Gibt zurück:

A response containing the success status.

start

public static String start(spark.Request request,
 spark.Response response)

Create and start a new process. See DUUIProcessController.start(Document, Document, DUUIDocumentProvider, DUUIDocumentProvider).

Gibt zurück:

The created process or an error response.

stop

public static String stop(spark.Request request,
 spark.Response response)

Cancel a process that is currently running. See DUUIProcessController.stop(String)

Gibt zurück:

The result of the cancellation (success or fail).

findDocuments

public static String findDocuments(spark.Request request,
 spark.Response response)

Retrieve a limited number of documents from the database. See DUUIDocumentController.findMany(MongoDBFilters).

Gibt zurück:

A JSON Document containing DUUIDocuments and the total count.

findEvents

public static String findEvents(spark.Request request,
 spark.Response response)

Retrieve events associated with the process. See DUUIEventController.findManyByProcess(String)

Gibt zurück:

a timeline (List) of events.