Interface for the taskflow service. More...

Inheritance diagram for de.zib.gndms.common.GORFX.service.TaskFlowService:

Public Member Functions
ResponseEntity< Void >	deleteTaskflow (String type, String id, String dn, String wid)
	Deletes a task flow.
ResponseEntity< Order >	getOrder (String type, String id, String dn, String wid)
	Delivers the order of the task flow.
ResponseEntity< Void >	setOrder (String type, String id, Order orq, String dn, String wid)
	Changes the order of a task flow.
ResponseEntity< List < Specifier< Quote > > >	getQuotes (String type, String id, String dn, String wid)
	Delivers all quotes for the order.
ResponseEntity< Integer >	setQuote (String type, String id, Quote cont, String dn, String wid)
	Allows the client to provide a preferred quote.
ResponseEntity< Quote >	getQuote (String type, String id, int idx, String dn, String wid)
	Delivers a single quote.
ResponseEntity< Void >	deleteQuotes (String type, String id, int idx, String dn, String wid)
	Removes a quote form the list, ^.
ResponseEntity< Specifier < Facets > >	getTask (String type, String id, String dn, String wid)
	Requests the task of the taskflow.
ResponseEntity< Specifier < Facets > >	createTask (String type, String id, Integer quoteId, String dn, String wid)
	Creates the task for a taskflow.
ResponseEntity< TaskFlowStatus >	getStatus (String type, String id, String dn, String wid)
	Delivers the status of the taskflow execution.
ResponseEntity< Specifier < TaskResult > >	getResult (String type, String id, String dn, String wid)
	Delivers the result of the taskflow execution.
ResponseEntity< Specifier < TaskFailure > >	getErrors (String type, String id, String dn, String wid)
	Delivers possible errors from the task(flow) execution.
Package Functions
ResponseEntity< Facets >	getFacets (String type, String id, String dn)
	Delivers all facets of a task flow.

Detailed Description

Interface for the taskflow service.

Author:: try ma ik jo rr a zib

Date:: 09.02.11, Time: 18:45

The taskflow service acts as interface to instantiated taskflow resources. The instantiation or creation happens through the GORFX service itself.

Regarding the return values if not documented differently the HttpStatus is 200 (OK) if the call was successful, 404 if the resource wasn't found or 403 (Forbidden) if the user hasn't the necessary credentials to access the resource.

Member Function Documentation

ResponseEntity<Specifier<Facets> > de.zib.gndms.common.GORFX.service.TaskFlowService.createTask	(	String	type,
		String	id,
		Integer	quoteId,
		String	dn,
		String	wid
	)

Creates the task for a taskflow.

The creation of the task requires a valid order.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
quoteId	The id of the quote which should be honored. (OPTIONAL, can be null, String wid ).
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: HTTP-status 201 if the creation was successful, together with the URL of the created resource. HTTP-status 409 if the task already exists.

ResponseEntity<Void> de.zib.gndms.common.GORFX.service.TaskFlowService.deleteQuotes	(	String	type,
		String	id,
		int	idx,
		String	dn,
		String	wid
	)

Removes a quote form the list, ^.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
idx	The index of the quote.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: a confirmation

Note:: I think this is required.

ResponseEntity<Void> de.zib.gndms.common.GORFX.service.TaskFlowService.deleteTaskflow	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Deletes a task flow.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:

Possible HTTP-Status values:

200 if the taskflow was deleted successful.
404 if the taskflow doesn't exist.
403 if the caller isn't allowed to remove the task.

ResponseEntity<Specifier<TaskFailure> > de.zib.gndms.common.GORFX.service.TaskFlowService.getErrors	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Delivers possible errors from the task(flow) execution.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:

Possible values:

404 if there haven't been errors yet,
302 together with the task URL, note this doesn't mean that the task has failed, just that the task is running and the taskflow is still fine.
200 together with the error of the taskflow, e.g. an unfulfillable order.

ResponseEntity<Facets> de.zib.gndms.common.GORFX.service.TaskFlowService.getFacets	(	String	type,
		String	id,
		String	dn
	)		`[package]`

Delivers all facets of a task flow.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.

Returns:: The facets of the task flow.

ResponseEntity<Order> de.zib.gndms.common.GORFX.service.TaskFlowService.getOrder	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Delivers the order of the task flow.

The order contains the parameters of the taskflow, i.e. which data to stage, or the source and destination for a file transfer...

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: The order details of the task flow and HttpStatus.Ok, or 404 if there isn't any order.

ResponseEntity<Quote> de.zib.gndms.common.GORFX.service.TaskFlowService.getQuote	(	String	type,
		String	id,
		int	idx,
		String	dn,
		String	wid
	)

Delivers a single quote.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
idx	The index of the quote.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: The quote, or HTTP-status 404 if the index doesn't point to a valid quote.

ResponseEntity<List<Specifier<Quote> > > de.zib.gndms.common.GORFX.service.TaskFlowService.getQuotes	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Delivers all quotes for the order.

Quotations are used for co-scheduling and describe temporal constrains for the taskflow executions. Its possible that there are more then one quotes for a task flow.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:

A list of quotes specifiers, which carry the quote information as payload.

200 if all went well,
400 if the order wasn't correct or unfulfillable.
404 if type or id are not valid.

ResponseEntity<Specifier<TaskResult> > de.zib.gndms.common.GORFX.service.TaskFlowService.getResult	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Delivers the result of the taskflow execution.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: The a specifier for the task result, which carries the result as payload if available, which might be HTTP-status 302 together with the URL of the task result or 404 if no result is available.

ResponseEntity<TaskFlowStatus> de.zib.gndms.common.GORFX.service.TaskFlowService.getStatus	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Delivers the status of the taskflow execution.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: The taskflow status, which might be HTTP-status 302 together with the URL of the task status if the task is running or 200 together with the status description of the taskflow. Note the 200 doesn't mean that the taskflow is okay, the status can be failed.

ResponseEntity<Specifier<Facets> > de.zib.gndms.common.GORFX.service.TaskFlowService.getTask	(	String	type,
		String	id,
		String	dn,
		String	wid
	)

Requests the task of the taskflow.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: The specifier of the task resource or HTTP-status 404 the task hasn't been created yet.

ResponseEntity<Void> de.zib.gndms.common.GORFX.service.TaskFlowService.setOrder	(	String	type,
		String	id,
		Order	orq,
		String	dn,
		String	wid
	)

Changes the order of a task flow.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
orq	The new order.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:

A confirmation if the order was accepted, in the HTTP-status of the response entity.

200 if it was accepted
400 if it wasn't successfully validated
404 if type or id are not valid.

ResponseEntity<Integer> de.zib.gndms.common.GORFX.service.TaskFlowService.setQuote	(	String	type,
		String	id,
		Quote	cont,
		String	dn,
		String	wid
	)

Allows the client to provide a preferred quote.

If the preferred quote is valid, wrt. it can be satisfied, it is added to the list of possible quotes. Use getQuote() to see if the quote was accepted.

Parameters:

type	The type of the task flow.
id	The id of the task flow.
cont	The preferred quote.
dn	The dn of the user invoking the method.
wid	The id of the workflow, for logging purpose.

Returns:: a confirmation

Note:: Only one preferred quote can be provided and will overwrite previously provided quotes.

The documentation for this interface was generated from the following file:

common/src/de/zib/gndms/common/GORFX/service/TaskFlowService.java

de.zib.gndms.common.GORFX.service.TaskFlowService Interface Reference

Public Member Functions

Package Functions

Detailed Description

Member Function Documentation