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

The FULL interface of the GORFX service. More...

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

List of all members.

Public Member Functions
ResponseEntity< ConfigMeta >	getConfigActionInfo (String actionName, String dn)
	Delivers usage information about a specific config action.
ResponseEntity< String >	callConfigAction (String actionName, String args, String dn)
	Executes a config action with the given arguments.
ResponseEntity< List< String > >	listBatchActions (String dn)
	Lists all batch actions.
ResponseEntity< ActionMeta >	getBatchActionInfo (String actionName, String dn)
	Delivers usage information about a specific config action.
ResponseEntity< Specifier < Facets > >	getBatchAction (String actionName, String id, String dn)
	Delivers the specifier of a running action.
ResponseEntity< Specifier >	callBatchAction (String actionName, String args, String dn)
	Executes a config action with the given arguments.
Package Functions
ResponseEntity< List< String > >	listConfigActions (String dn)
	Lists all actions of the config facet.

---

Detailed Description

The FULL interface of the GORFX service.

Author:

try ma ik jo rr a zib Date: 08.02.11, Time: 12:14

Clients and resources which should provide the full feature catalog of the gorfx service should implement this interface.

The additional calles are for system maintenance and one-shot tasks.

Some general remarks on the parameters:

• The dn parameter is a identifier for the user responsible for the method invocation. It is required to check if the user has the necessary permissions for the call.
  Using REST the attribute should be provided using a http-header property called "DN".
• wid stands for Workflow-ID and is used to associate calles to a single workflow mainly for logging and debugging.
  Using REST the attribute should be provided using a http-header property "wid".

---

Member Function Documentation

ResponseEntity<Specifier> de.zib.gndms.common.GORFX.service.GORFXService.callBatchAction	(	String	actionName,
		String	args,
		String	dn
	)

Executes a config action with the given arguments.

See also:

GORFXService.callConfigAction() for details.

Parameters:

actionName	The name of the action to execute.
args	The arguments of the action.
dn	The dn of the user invoking the method.

Returns:

A batch action specifier which might contain the result object, or if it triggers task a specifier for the task.

ResponseEntity<String> de.zib.gndms.common.GORFX.service.GORFXService.callConfigAction	(	String	actionName,
		String	args,
		String	dn
	)

Executes a config action with the given arguments.

Note:

At time being the config actions are designed for interactive operation with human beings. This has two consequences for this method signature.

• Currently action arguments are provided as a key:vales in string format, it is highly possible that this will change to a real Map, this concerns the args parameter.
• Same applies for the return value which is currently in string form.

Will be encapsulated with some web pages in future versions, which will cause a change to a more machine-friendly representation of the values.

Parameters:

actionName	The name of the config action to execute.
args	The arguments of the action.
dn	The dn of the user invoking the method.

Returns:

The result state of the action.

ResponseEntity<Specifier<Facets> > de.zib.gndms.common.GORFX.service.GORFXService.getBatchAction	(	String	actionName,
		String	id,
		String	dn
	)

Delivers the specifier of a running action.

Parameters:

actionName	The name of the action
id	The id of the running action.
dn	The dn of the user invoking the method.

Returns:

HttpStatus 200 together with a task specifier if the batch exists, 404 otherwise.

Implemented in de.zib.gndms.gndmc.gorfx.FullGORFXClient.

ResponseEntity<ActionMeta> de.zib.gndms.common.GORFX.service.GORFXService.getBatchActionInfo	(	String	actionName,
		String	dn
	)

Delivers usage information about a specific config action.

The usage information includes a description of the action, together with a description of its parameters.

Parameters:

actionName	The name of the action
dn	The dn of the user invoking the method.

Returns:

The "help" of the action.

ResponseEntity<ConfigMeta> de.zib.gndms.common.GORFX.service.GORFXService.getConfigActionInfo	(	String	actionName,
		String	dn
	)

Delivers usage information about a specific config action.

The usage information includes a description of the configuration action, together with a description of its parameters.

Parameters:

actionName	The name of the action
dn	The dn of the user invoking the method.

Returns:

The "help" of the action.

ResponseEntity<List<String> > de.zib.gndms.common.GORFX.service.GORFXService.listBatchActions

(

String

dn

)

Lists all batch actions.

Batch actions are actions which perform simple tasks, which aren't part of a workflow. They are mostly used for system maintenance.

Returns:

A list of action names.

Parameters:

dn	The dn of the user invoking the method.

ResponseEntity<List<String> > de.zib.gndms.common.GORFX.service.GORFXService.listConfigActions

(

String

dn

)

[package]

Lists all actions of the config facet.

A config action is a configuration unit dedicated to a specific aspect of GNDMS.

Parameters:

dn	The dn of the user invoking the method.

Returns:

List of config actions names.

---

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

• common/src/de/zib/gndms/common/GORFX/service/GORFXService.java