com.marklogic.hub

Interface FlowManager

All Known Implementing Classes:

FlowManagerImpl

public interface FlowManager

Manages CRUD operations for flows

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FLOW_FILE_EXTENSION String value for the flow file extension

Method Summary

Modifier and Type	Method and Description
Flow	createFlow(java.lang.String flowName) Creates a flow
Flow	createFlowFromJSON(com.fasterxml.jackson.databind.JsonNode json) Creates a flow from a given JsonNode
Flow	createFlowFromJSON(java.lang.String json) Creates a flow from a given JSON string
void	deleteFlow(java.lang.String flowName) Deletes a flow
void	deleteStep(Flow flow, java.lang.String stepKey)
Flow	getFlow(java.lang.String flowName) Retrieves a named flow
java.lang.String	getFlowAsJSON(java.lang.String flowName) Returns a flow based on the provided name as JSON string
java.util.List<java.lang.String>	getFlowNames() Retrieves a list of names of flows installed on the MarkLogic server
java.util.List<Flow>	getFlows() Retrieves a list of flows installed on the MarkLogic server
Step	getStep(Flow flow, java.lang.String stepNum) Deprecated.
java.util.Map<java.lang.String,Step>	getSteps(Flow flow) Deprecated.
boolean	isFlowExisted(java.lang.String flowName) Check if a flow has existed
void	saveFlow(Flow flow) Saves a flow to disk
void	setHubConfig(HubConfig hubConfig) Set the HubConfig
void	setSteps(Flow flow, java.util.Map<java.lang.String,Step> stepMap) Deprecated.

Field Detail

FLOW_FILE_EXTENSION

static final java.lang.String FLOW_FILE_EXTENSION

String value for the flow file extension

See Also:

Constant Field Values

Method Detail

setHubConfig

void setHubConfig(HubConfig hubConfig)

Set the HubConfig

Parameters:

hubConfig - - the hubConfig to use

getFlow

Flow getFlow(java.lang.String flowName)

Retrieves a named flow

Parameters:

flowName - - name of the flow

Returns:

a flow object

getFlowAsJSON

java.lang.String getFlowAsJSON(java.lang.String flowName)

Returns a flow based on the provided name as JSON string

Parameters:

flowName - - name of the flow

Returns:

string json representation of the flow object

getFlows

java.util.List<Flow> getFlows()

Retrieves a list of flows installed on the MarkLogic server

Returns:

- a list of all flows

getFlowNames

java.util.List<java.lang.String> getFlowNames()

Retrieves a list of names of flows installed on the MarkLogic server

Returns:

- a list of names of all flows

createFlow

Flow createFlow(java.lang.String flowName)

Creates a flow

Parameters:

flowName - - name of the flow

Returns:

a Flow object

createFlowFromJSON

Flow createFlowFromJSON(java.lang.String json)

Creates a flow from a given JSON string

Parameters:

json - - string representation of the flow

Returns:

- a Flow object

createFlowFromJSON

Flow createFlowFromJSON(com.fasterxml.jackson.databind.JsonNode json)

Creates a flow from a given JsonNode

Parameters:

json - - JsonNode representation of the flow

Returns:

- a Flow object

deleteFlow

void deleteFlow(java.lang.String flowName)

Deletes a flow

Parameters:

flowName - - name of the flow

saveFlow

void saveFlow(Flow flow)

Saves a flow to disk

Parameters:

flow - - the flow object to be saved

deleteStep

void deleteStep(Flow flow,
                java.lang.String stepKey)

Parameters:

flow -

stepKey - the step map key corresponding to the step to delete

isFlowExisted

boolean isFlowExisted(java.lang.String flowName)

Check if a flow has existed

Parameters:

flowName - a flow name

Returns:

a boolean value

getSteps

@Deprecated
java.util.Map<java.lang.String,Step> getSteps(Flow flow)

Deprecated.

Use flow.getSteps()

Parameters:

flow - a flow object

Returns:

a map of steps

setSteps

@Deprecated
void setSteps(Flow flow,
                          java.util.Map<java.lang.String,Step> stepMap)

Deprecated.

Use flow.setSteps(stepMap)

Parameters:

flow - a flow object

stepMap - a map of steps

getStep

@Deprecated
Step getStep(Flow flow,
                         java.lang.String stepNum)

Deprecated.

Use flow.getStep(stepNum)

Parameters:

flow - a flow object

stepNum - step key

Returns:

a step