Class FlowManager


  • public final class FlowManager
    extends java.lang.Object
    Flow manager.
    Since:
    12.0.0
    Version:
    $Revision: 24894 $ $Date: 2022-03-22 09:07:07 -0300 (Tue, 22 Mar 2022) $
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void deleteFlowsById​(java.lang.String serviceInstanceId, java.lang.String... ids)
      Delete flows by identifiers.
      static void deleteFlowsById​(java.util.Collection<java.lang.String> ids, java.lang.String serviceInstanceId)
      Delete flows by identifiers.
      static void deleteFlowsByServiceInstanceId​(java.lang.String serviceInstanceId)
      Delete all flows entry by service instance identifier.
      static java.util.Collection<FlowEntry> getAllFlows()
      Returns all flows.
      static FlowEntry getById​(java.lang.String id)
      Returns the flow entry by the given identifier.
      static FlowEntry getByNameAndServiceInstance​(java.lang.String name, java.lang.String serviceInstanceId)
      Returns flow entry by name and service instance identifiers.
      static java.util.Collection<FlowEntry> getByServiceInstance​(java.lang.String serviceInstanceId)
      Returns all flows entries by service instance identifiers.
      static void onEvent​(IMonitorEvent event, java.util.Deque<IMonitorValuesProvider> monitoringValues, Document document)
      Receives an event from monitor framework
      static void removeFlowsWaitingForEventCache​(java.lang.String eventId)
      Remove the cache item for event identifier in flows waiting for event cache.
      static FlowEntry saveAs​(java.lang.String name, Flow flow, java.lang.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

      • scheduleClearCache

        public static void scheduleClearCache()
                                       throws PortalException
        Schedule clear cache flows.
        Throws:
        PortalException
        Since:
        12.0.0
      • saveAs

        public static FlowEntry saveAs​(java.lang.String name,
                                       Flow flow,
                                       java.lang.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
      • removeFlowsWaitingForEventCache

        public static void removeFlowsWaitingForEventCache​(java.lang.String eventId)
        Remove the cache item for event identifier in flows waiting for event cache.
        Parameters:
        eventId - the event identifier.
        Since:
        12.2.0
      • deleteFlowsByServiceInstanceId

        public static void deleteFlowsByServiceInstanceId​(java.lang.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​(java.lang.String serviceInstanceId,
                                           java.lang.String... ids)
                                    throws PortalException
        Delete flows by identifiers.
        Parameters:
        ids - the flow identifiers.
        Throws:
        PortalException
        Since:
        12.0.0
      • deleteFlowsById

        public static void deleteFlowsById​(java.util.Collection<java.lang.String> ids,
                                           java.lang.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​(java.lang.String name,
                                                            java.lang.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 java.util.Collection<FlowEntry> getByServiceInstance​(java.lang.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​(java.lang.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