Package io.vertigo.orchestra.webservices

Class WsDefinition

java.lang.Object

io.vertigo.orchestra.webservices.WsDefinition

All Implemented Interfaces:

io.vertigo.core.node.component.Component, io.vertigo.core.node.component.CoreComponent, WebServices

@PathPrefix("/orchestra/definitions")
public class WsDefinition
extends Object
implements WebServices

WebService API for managing ProcessDefinitions

Version:

$Id$

Author:

mlaroche.

Constructor Summary

Constructors

Constructor	Description
WsDefinition()

Method Summary

Modifier and Type	Method	Description
ProcessDefinition	getProcessById(String processName)	Retourne un processus par son id.
List<ProcessDefinition>	searchProcessByLabel(String criteria)	Retourne la liste des processus correspondant à un critère de recherche.
ProcessDefinition	updateInitialParams(String processName, Map<String,String> initialParams)	Mets à jour les paramètres initiaux de démarrage d'un processus
ProcessDefinition	updateProcessProperties(String processName, Optional<String> cronExpression, boolean multiExecution, int rescuePerdiodSeconds, boolean active)	Met à jour les propriétés d'un processus.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsDefinition

public WsDefinition()

Method Detail

getProcessById

@GET("/{processName}")
public ProcessDefinition getProcessById(@PathParam("processName")
                                        String processName)

Retourne un processus par son id.

Parameters:

processName - l'id du processus

Returns:

le processus

searchProcessByLabel

@POST("/_search")
public List<ProcessDefinition> searchProcessByLabel(@InnerBodyParam("criteria")
                                                    String criteria)

Retourne la liste des processus correspondant à un critère de recherche.

Parameters:

criteria - le critère

Returns:

la liste de resultats

updateProcessProperties

@PUT("/{processName}/properties")
public ProcessDefinition updateProcessProperties(@PathParam("processName")
                                                 String processName,
                                                 @InnerBodyParam("cronExpression")
                                                 Optional<String> cronExpression,
                                                 @InnerBodyParam("multiExecution")
                                                 boolean multiExecution,
                                                 @InnerBodyParam("rescuePeriod")
                                                 int rescuePerdiodSeconds,
                                                 @InnerBodyParam("active")
                                                 boolean active)

Met à jour les propriétés d'un processus.

Parameters:

processName - l'id du processus à mettre à jour

cronExpression - la nouvelle expression cron de récurrence

multiExecution - le processus autorise-t-il la multi-exécution

rescuePerdiodSeconds - le temps de validité d'une planification

active - si le processus est actif

Returns:

le processus mis à jour

updateInitialParams

@PUT("/{processName}/params")
public ProcessDefinition updateInitialParams(@PathParam("processName")
                                             String processName,
                                             @InnerBodyParam("initialParams")
                                             Map<String,String> initialParams)

Mets à jour les paramètres initiaux de démarrage d'un processus

Parameters:

processName - l'id du processus à mettre à jour

initialParams - les nouveaux paramètres à utiliser (JSON sous forme de string)

Returns:

le processus mis à jour