lumis.portal.analytics.automationflow

Class FlowManager

java.lang.Object

lumis.portal.analytics.automationflow.FlowManager

public final class FlowManager
extends Object

Flow manager.

Since:

12.0.0

Version:

$Revision: 23104 $ $Date: 2019-09-03 19:01:26 +0000 (Tue, 03 Sep 2019) $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowManager.AutomationFlowMonitorValuesProvider Automation flow values provider.

Method Summary

Modifier and Type	Method and Description
static void	deleteFlowsById(Collection<String> ids, String serviceInstanceId) Delete flows by identifiers.
static void	deleteFlowsById(String serviceInstanceId, String... ids) Delete flows by identifiers.
static void	deleteFlowsByServiceInstanceId(String serviceInstanceId) Delete all flows entry by service instance identifier.
static Collection<FlowEntry>	getAllFlows() Returns all flows.
static FlowEntry	getById(String id) Returns the flow entry by the given identifier.
static FlowEntry	getByNameAndServiceInstance(String name, String serviceInstanceId) Returns flow entry by name and service instance identifiers.
static Collection<FlowEntry>	getByServiceInstance(String serviceInstanceId) Returns all flows entries by service instance identifiers.
static void	onEvent(IMonitorEvent event, Deque<IMonitorValuesProvider> monitoringValues, Document document) Receives an event from monitor framework
static FlowEntry	saveAs(String name, Flow flow, String serviceInstanceId) Save the given flow.
static void	scheduleClearCache() Schedule clear cache flows.

Methods inherited from class java.lang.Object

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

Method Detail

getAllFlows

public static Collection<FlowEntry> getAllFlows()
                                         throws PortalException

Returns all flows.

Returns:

all flows.

Throws:

PortalException

Since:

12.0.0

scheduleClearCache

public static void scheduleClearCache()
                               throws PortalException

Schedule clear cache flows.

Throws:

PortalException

Since:

12.0.0

onEvent

public static void onEvent(IMonitorEvent event,
                           Deque<IMonitorValuesProvider> monitoringValues,
                           Document document)
                    throws PortalException

Receives an event from monitor framework

Parameters:

event - the event

monitoringValues - the event data

document - the event data document

Throws:

PortalException

Since:

12.0.0

saveAs

public static FlowEntry saveAs(String name,
                               Flow flow,
                               String serviceInstanceId)
                        throws PortalException

Save the given flow.

Parameters:

name - the flow name

flow - the flow

serviceInstanceId - the service instance identifier

Returns:

the saved flow

Throws:

PortalException - if the flow validation detects any problem.

Since:

12.0.0

deleteFlowsByServiceInstanceId

public static void deleteFlowsByServiceInstanceId(String serviceInstanceId)
                                           throws PortalException

Delete all flows entry by service instance identifier.

Parameters:

serviceInstanceId - the service instance identifier.

Throws:

PortalException

Since:

12.0.0

deleteFlowsById

public static void deleteFlowsById(String serviceInstanceId,
                                   String... ids)
                            throws PortalException

Delete flows by identifiers.

Parameters:

ids - the flow identifiers.

Throws:

PortalException

Since:

12.0.0

deleteFlowsById

public static void deleteFlowsById(Collection<String> ids,
                                   String serviceInstanceId)
                            throws PortalException

Delete flows by identifiers.

Parameters:

ids - the flow identifiers.

serviceInstanceId - the service instance identifier.

Throws:

PortalException

Since:

12.0.0

getByNameAndServiceInstance

public static FlowEntry getByNameAndServiceInstance(String name,
                                                    String serviceInstanceId)
                                             throws PortalException

Returns flow entry by name and service instance identifiers.

Parameters:

name - the name.

serviceInstanceId - service instance identifiers.

Returns:

flow entry by name and service instance identifiers or null if no such flow entry was found.

Throws:

PortalException

Since:

12.0.0

getByServiceInstance

public static Collection<FlowEntry> getByServiceInstance(String serviceInstanceId)

Returns all flows entries by service instance identifiers.

Parameters:

serviceInstanceId - service instance identifiers.

Returns:

all flows entries by service instance identifiers.

Since:

12.0.0

getById

public static FlowEntry getById(String id)

Returns the flow entry by the given identifier.

Parameters:

id - the flow entry identifier.

Returns:

the flow entry by the given identifier

Since:

12.0.0