FlowManagerImpl (marklogic-data-hub 5.8.0 API)

java.lang.Object
- com.marklogic.client.ext.helper.LoggingObject
- - com.marklogic.hub.impl.FlowManagerImpl

All Implemented Interfaces:: FlowManager

@Component
public class FlowManagerImpl
extends com.marklogic.client.ext.helper.LoggingObject
implements FlowManager

Field Summary
- Fields inherited from class com.marklogic.client.ext.helper.LoggingObject
  logger
- Fields inherited from interface com.marklogic.hub.FlowManager
  FLOW_FILE_EXTENSION

Constructor Summary

Constructors
Constructor and Description
`FlowManagerImpl()`
`FlowManagerImpl(com.marklogic.hub.HubClient hubClient)`
`FlowManagerImpl(HubConfig hubConfig)`
`FlowManagerImpl(HubConfig hubConfig, MappingManager mappingManager)`
`FlowManagerImpl(HubConfig hubConfig, MappingManager mappingManager, StepDefinitionManager stepDefinitionManager)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`org.apache.commons.lang3.tuple.Pair<java.io.File,java.lang.String>`	`addStepToFlow(java.lang.String flowName, java.lang.String stepName, java.lang.String stepType)`
`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
`protected void`	`deleteDocumentsInDirectory(java.lang.String directory)`
`void`	`deleteFlow(java.lang.String flowName)` Deletes a flow
`protected void`	`deleteMappingArtifacts(Flow flow, Step removedStep)`
`protected void`	`deleteRelatedStepArtifacts(Flow flow, Step removedStep)` For certain step types, when the step is deleted, we need to do some cleanup of artifacts on disk and in the staging and final databases.
`void`	`deleteStep(Flow flow, java.lang.String key)`
`protected void`	`deleteStepDefinitionArtifacts(Step removedStep, StepDefinition.StepDefinitionType stepTypeOfRemovedStep)`
`protected ArtifactService`	`getArtifactService()`
`java.io.File`	`getFileForLocalFlow(java.lang.String flowName)`
`Flow`	`getFlow(java.lang.String flowName)` Retrieves a named flow on the MarkLogic server
`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
`protected FlowService`	`getFlowService()`
`Flow`	`getFullFlow(java.lang.String flowName)` Retrieves the expanded flow document with properties from artifact and settings
`Flow`	`getLocalFlow(java.lang.String flowName)` Retrieves a named flow from the Data Hub project
`com.fasterxml.jackson.databind.node.ObjectNode`	`getLocalFlowAsJSON(java.lang.String flowName)`
`java.util.List<java.lang.String>`	`getLocalFlowNames()` Retrieves a list of names of flows in the local project
`java.util.List<Flow>`	`getLocalFlows()` Retrieves a list of flows in a Data Hub project
`java.util.List<com.fasterxml.jackson.databind.node.ObjectNode>`	`getLocalFlowsAsJSON()` Retrieves a list of flows in a Data Hub project
`Step`	`getStep(Flow flow, java.lang.String stepNum)` Deprecated.
`java.util.Map<java.lang.String,Step>`	`getSteps(Flow flow)` Deprecated.
`protected boolean`	`isCustomMapping(Step removedStep)`
`boolean`	`isFlowExisted(java.lang.String flowName)` Check if a flow has existed
`protected boolean`	`mappingIsReferencedByAFlow(Step removedStep)`
`static Step`	`removeStepFromFlow(Flow flow, java.lang.String key)` Extracted for reuse in HubCentral
`void`	`saveFlow(Flow flow)` Saves a flow to project structure and MarkLogic instance
`void`	`saveLocalFlow(Flow flow)` Saves a flow to project structure
`void`	`setHubConfig(HubConfig hubConfig)` Set the HubConfig
`void`	`setSteps(Flow flow, java.util.Map<java.lang.String,Step> stepMap)` Deprecated.
`protected boolean`	`stepIsReferencedByAFlow(java.lang.String stepName, StepDefinition.StepDefinitionType stepType)`

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject
format

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FlowManagerImpl
```
public FlowManagerImpl()
```
  - FlowManagerImpl
```
public FlowManagerImpl(HubConfig hubConfig)
```
  - FlowManagerImpl
```
public FlowManagerImpl(com.marklogic.hub.HubClient hubClient)
```
  - FlowManagerImpl
```
public FlowManagerImpl(HubConfig hubConfig,
                       MappingManager mappingManager)
```
  - FlowManagerImpl
```
public FlowManagerImpl(HubConfig hubConfig,
                       MappingManager mappingManager,
                       StepDefinitionManager stepDefinitionManager)
```
- Method Detail
  - setHubConfig
```
public void setHubConfig(HubConfig hubConfig)
```
    Description copied from interface: FlowManager
    
    Set the HubConfig
    
    Specified by:
    
    setHubConfig in interface FlowManager
    
    Parameters:
    
    hubConfig - - the hubConfig to use
  - getFlow
```
public Flow getFlow(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Retrieves a named flow on the MarkLogic server
    
    Specified by:
    
    getFlow in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
    
    Returns:
    
    a flow object
  - getLocalFlow
```
public Flow getLocalFlow(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Retrieves a named flow from the Data Hub project
    
    Specified by:
    
    getLocalFlow in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
    
    Returns:
    
    a flow object from the local Data Hub project
  - getLocalFlowAsJSON
```
public com.fasterxml.jackson.databind.node.ObjectNode getLocalFlowAsJSON(java.lang.String flowName)
```
  - getFullFlow
```
public Flow getFullFlow(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Retrieves the expanded flow document with properties from artifact and settings
    
    Specified by:
    
    getFullFlow in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
    
    Returns:
    
    a flow object to be used by FlowRunner
  - getFlowAsJSON
```
public java.lang.String getFlowAsJSON(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Returns a flow based on the provided name as JSON string
    
    Specified by:
    
    getFlowAsJSON in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
    
    Returns:
    
    string json representation of the flow object
  - getFlows
```
public java.util.List<Flow> getFlows()
```
    Description copied from interface: FlowManager
    
    Retrieves a list of flows installed on the MarkLogic server
    
    Specified by:
    
    getFlows in interface FlowManager
    
    Returns:
    
    - a list of all flows on the MarkLogic server
  - getLocalFlowNames
```
public java.util.List<java.lang.String> getLocalFlowNames()
```
    Description copied from interface: FlowManager
    
    Retrieves a list of names of flows in the local project
    
    Specified by:
    
    getLocalFlowNames in interface FlowManager
    
    Returns:
    
    - a list of names of all flows
  - getFlowNames
```
public java.util.List<java.lang.String> getFlowNames()
```
    Description copied from interface: FlowManager
    
    Retrieves a list of names of flows installed on the MarkLogic server
    
    Specified by:
    
    getFlowNames in interface FlowManager
    
    Returns:
    
    - a list of names of all flows
  - createFlow
```
public Flow createFlow(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Creates a flow
    
    Specified by:
    
    createFlow in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
    
    Returns:
    
    a Flow object
  - createFlowFromJSON
```
public Flow createFlowFromJSON(java.lang.String json)
```
    Description copied from interface: FlowManager
    
    Creates a flow from a given JSON string
    
    Specified by:
    
    createFlowFromJSON in interface FlowManager
    
    Parameters:
    
    json - - string representation of the flow
    
    Returns:
    
    - a Flow object
  - createFlowFromJSON
```
public Flow createFlowFromJSON(com.fasterxml.jackson.databind.JsonNode json)
```
    Description copied from interface: FlowManager
    
    Creates a flow from a given JsonNode
    
    Specified by:
    
    createFlowFromJSON in interface FlowManager
    
    Parameters:
    
    json - - JsonNode representation of the flow
    
    Returns:
    
    - a Flow object
  - deleteFlow
```
public void deleteFlow(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Deletes a flow
    
    Specified by:
    
    deleteFlow in interface FlowManager
    
    Parameters:
    
    flowName - - name of the flow
  - deleteStep
```
public void deleteStep(Flow flow,
                       java.lang.String key)
```
    Specified by:
    
    deleteStep in interface FlowManager
    
    key - the step map key corresponding to the step to delete
  - removeStepFromFlow
```
public static Step removeStepFromFlow(Flow flow,
                                      java.lang.String key)
```
    Extracted for reuse in HubCentral
    
    Parameters:
    
    flow -
    
    key -
    
    Returns:
  - saveLocalFlow
```
public void saveLocalFlow(Flow flow)
```
    Description copied from interface: FlowManager
    
    Saves a flow to project structure
    
    Specified by:
    
    saveLocalFlow in interface FlowManager
    
    Parameters:
    
    flow - - the flow object to be saved
  - getFileForLocalFlow
```
public java.io.File getFileForLocalFlow(java.lang.String flowName)
```
  - saveFlow
```
public void saveFlow(Flow flow)
```
    Description copied from interface: FlowManager
    
    Saves a flow to project structure and MarkLogic instance
    
    Specified by:
    
    saveFlow in interface FlowManager
    
    Parameters:
    
    flow - - the flow object to be saved
  - addStepToFlow
```
public org.apache.commons.lang3.tuple.Pair<java.io.File,java.lang.String> addStepToFlow(java.lang.String flowName,
                                                                                        java.lang.String stepName,
                                                                                        java.lang.String stepType)
```
  - isFlowExisted
```
public boolean isFlowExisted(java.lang.String flowName)
```
    Description copied from interface: FlowManager
    
    Check if a flow has existed
    
    Specified by:
    
    isFlowExisted in interface FlowManager
    
    Parameters:
    
    flowName - a flow name
    
    Returns:
    
    a boolean value
  - getArtifactService
```
protected ArtifactService getArtifactService()
```
  - getFlowService
```
protected FlowService getFlowService()
```
  - getSteps
```
@Deprecated
public java.util.Map<java.lang.String,Step> getSteps(Flow flow)
```
    Deprecated.
    
    Description copied from interface: FlowManager
    
    Use flow.getSteps()
    
    Specified by:
    
    getSteps in interface FlowManager
    
    Parameters:
    
    flow - a flow object
    
    Returns:
    
    a map of steps
  - getStep
```
@Deprecated
public Step getStep(Flow flow,
                                java.lang.String stepNum)
```
    Deprecated.
    
    Description copied from interface: FlowManager
    
    Use flow.getStep(stepNum)
    
    Specified by:
    
    getStep in interface FlowManager
    
    Parameters:
    
    flow - a flow object
    
    stepNum - step key
    
    Returns:
    
    a step
  - setSteps
```
@Deprecated
public void setSteps(Flow flow,
                                 java.util.Map<java.lang.String,Step> stepMap)
```
    Deprecated.
    
    Description copied from interface: FlowManager
    
    Use flow.setSteps(stepMap)
    
    Specified by:
    
    setSteps in interface FlowManager
    
    Parameters:
    
    flow - a flow object
    
    stepMap - a map of steps
  - deleteRelatedStepArtifacts
```
protected void deleteRelatedStepArtifacts(Flow flow,
                                          Step removedStep)
```
    For certain step types, when the step is deleted, we need to do some cleanup of artifacts on disk and in the staging and final databases. So for a mapping - we need to get the name of the mapping and then see if any other flow references that mapping. For custom Mapping/Ingestion/Mastering, the type is not Custom, so we need to check for such step definition types to delete the step definition artifacts
    
    Parameters:
    
    flow -
    
    removedStep -
  - stepIsReferencedByAFlow
```
protected boolean stepIsReferencedByAFlow(java.lang.String stepName,
                                          StepDefinition.StepDefinitionType stepType)
```
    Parameters:
    
    stepName -
    
    stepType -
    
    Returns:
    
    true if any flow has a step with the given name and type
  - mappingIsReferencedByAFlow
```
protected boolean mappingIsReferencedByAFlow(Step removedStep)
```
    Parameters:
    
    removedStep -
    
    Returns:
    
    true if any flow has a step with a mapping with the same name as the mapping in the given step
  - isCustomMapping
```
protected boolean isCustomMapping(Step removedStep)
```
  - deleteMappingArtifacts
```
protected void deleteMappingArtifacts(Flow flow,
                                      Step removedStep)
```
  - deleteStepDefinitionArtifacts
```
protected void deleteStepDefinitionArtifacts(Step removedStep,
                                             StepDefinition.StepDefinitionType stepTypeOfRemovedStep)
```
  - deleteDocumentsInDirectory
```
protected void deleteDocumentsInDirectory(java.lang.String directory)
```
  - getLocalFlows
```
public java.util.List<Flow> getLocalFlows()
```
    Description copied from interface: FlowManager
    
    Retrieves a list of flows in a Data Hub project
    
    Specified by:
    
    getLocalFlows in interface FlowManager
    
    Returns:
    
    - a list of all flows in a project
  - getLocalFlowsAsJSON
```
public java.util.List<com.fasterxml.jackson.databind.node.ObjectNode> getLocalFlowsAsJSON()
```
    Description copied from interface: FlowManager
    
    Retrieves a list of flows in a Data Hub project
    
    Specified by:
    
    getLocalFlowsAsJSON in interface FlowManager
    
    Returns:
    
    - a list of all flows in a project as JSON

Class FlowManagerImpl

Field Summary

Fields inherited from class com.marklogic.client.ext.helper.LoggingObject

Fields inherited from interface com.marklogic.hub.FlowManager

Constructor Summary

Method Summary

Methods inherited from class com.marklogic.client.ext.helper.LoggingObject

Methods inherited from class java.lang.Object

Constructor Detail

FlowManagerImpl

FlowManagerImpl

FlowManagerImpl

FlowManagerImpl

FlowManagerImpl

Method Detail

setHubConfig

getFlow

getLocalFlow

getLocalFlowAsJSON

getFullFlow

getFlowAsJSON

getFlows

getLocalFlowNames

getFlowNames

createFlow

createFlowFromJSON

createFlowFromJSON

deleteFlow

deleteStep

removeStepFromFlow

saveLocalFlow

getFileForLocalFlow

saveFlow

addStepToFlow

isFlowExisted

getArtifactService

getFlowService

getSteps

getStep

setSteps

deleteRelatedStepArtifacts

stepIsReferencedByAFlow

mappingIsReferencedByAFlow

isCustomMapping

deleteMappingArtifacts

deleteStepDefinitionArtifacts

deleteDocumentsInDirectory

getLocalFlows

getLocalFlowsAsJSON