com.marklogic.hub

Class FlowManager

java.lang.Object

com.marklogic.client.impl.ResourceManagerImplementation

com.marklogic.client.extensions.ResourceManager

com.marklogic.hub.FlowManager

public class FlowManager
extends com.marklogic.client.extensions.ResourceManager

Constructor Summary

Constructors

Constructor and Description
FlowManager(HubConfig hubConfig)

Method Summary

Modifier and Type	Method and Description
static Flow	flowFromXml(org.w3c.dom.Element doc) Turns an XML document into a flow
Flow	getFlow(java.lang.String entityName, java.lang.String flowName) Retrieves a named flow from a given entity
Flow	getFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType)
Flow	getFlowFromProperties(java.nio.file.Path propertiesFile)
java.util.List<Flow>	getFlows(java.lang.String entityName) Retrieves a list of flows installed on the MarkLogic server
java.util.List<java.lang.String>	getLegacyFlows()
java.util.List<Flow>	getLocalFlows() retrieves a list of all the flows on the local files systems
java.util.List<Flow>	getLocalFlowsForEntity(java.lang.String entityName)
java.util.List<Flow>	getLocalFlowsForEntity(java.lang.String entityName, FlowType flowType)
FlowRunner	newFlowRunner()
java.util.List<java.lang.String>	updateLegacyFlows(java.lang.String fromVersion)

Methods inherited from class com.marklogic.client.extensions.ResourceManager

getName, startLogging, stopLogging

Methods inherited from class com.marklogic.client.impl.ResourceManagerImplementation

getServices

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowManager

public FlowManager(HubConfig hubConfig)

Method Detail

getLocalFlows

public java.util.List<Flow> getLocalFlows()

retrieves a list of all the flows on the local files systems

Returns:

a list of Flows

getLocalFlowsForEntity

public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName)

getLocalFlowsForEntity

public java.util.List<Flow> getLocalFlowsForEntity(java.lang.String entityName,
                                                   FlowType flowType)

getFlowFromProperties

public Flow getFlowFromProperties(java.nio.file.Path propertiesFile)

getFlows

public java.util.List<Flow> getFlows(java.lang.String entityName)

Retrieves a list of flows installed on the MarkLogic server

Parameters:

entityName - - the entity from which to fetch the flows

Returns:

- a list of flows for the given entity

getFlow

public Flow getFlow(java.lang.String entityName,
                    java.lang.String flowName)

Retrieves a named flow from a given entity

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

Returns:

the flow

getFlow

public Flow getFlow(java.lang.String entityName,
                    java.lang.String flowName,
                    FlowType flowType)

getLegacyFlows

public java.util.List<java.lang.String> getLegacyFlows()

updateLegacyFlows

public java.util.List<java.lang.String> updateLegacyFlows(java.lang.String fromVersion)

newFlowRunner

public FlowRunner newFlowRunner()

flowFromXml

public static Flow flowFromXml(org.w3c.dom.Element doc)

Turns an XML document into a flow

Parameters:

doc - - the xml document representing a flow

Returns:

a Flow instance