com.marklogic.hub.legacy.impl

Class LegacyFlowManagerImpl

java.lang.Object

com.marklogic.client.impl.ResourceManagerImplementation

com.marklogic.client.extensions.ResourceManager

com.marklogic.hub.legacy.impl.LegacyFlowManagerImpl

All Implemented Interfaces:

LegacyFlowManager

@Component
public class LegacyFlowManagerImpl
extends com.marklogic.client.extensions.ResourceManager
implements LegacyFlowManager

Constructor Summary

Constructors

Constructor and Description
LegacyFlowManagerImpl()

Method Summary

Modifier and Type	Method and Description
LegacyFlow	getFlow(java.lang.String entityName, java.lang.String flowName) Retrieves a named flow from a given entity
LegacyFlow	getFlow(java.lang.String entityName, java.lang.String flowName, FlowType flowType) Retrieves a named flow from a given entity
LegacyFlow	getFlowFromProperties(java.nio.file.Path propertiesFile) Obtains a flow from a property file
java.util.List<LegacyFlow>	getFlows(java.lang.String entityName) Retrieves a list of flows installed on the MarkLogic server
java.util.List<LegacyFlow>	getLocalFlows() retrieves a list of all the flows on the local files systems
java.util.List<LegacyFlow>	getLocalFlowsForEntity(java.lang.String entityName) retrieves a list of all the flows on the local files systems
java.util.List<LegacyFlow>	getLocalFlowsForEntity(java.lang.String entityName, FlowType flowType) retrieves a list of all the flows on the local files systems
LegacyFlowRunner	newFlowRunner() Creates and returns a new LegacyFlowRunner object using the FlowManager's hubconfig
void	setHubConfig(HubConfig hubConfig) Set HubConfig
void	setupClient()

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

Methods inherited from interface com.marklogic.hub.legacy.LegacyFlowManager

flowFromXml

Constructor Detail

LegacyFlowManagerImpl

public LegacyFlowManagerImpl()

Method Detail

setHubConfig

public void setHubConfig(HubConfig hubConfig)

Description copied from interface: LegacyFlowManager

Set HubConfig

Specified by:

setHubConfig in interface LegacyFlowManager

Parameters:

hubConfig - a hubConfig object

setupClient

public void setupClient()

getLocalFlows

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

Description copied from interface: LegacyFlowManager

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

Specified by:

getLocalFlows in interface LegacyFlowManager

Returns:

a list of Flows

getLocalFlowsForEntity

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

Description copied from interface: LegacyFlowManager

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

Specified by:

getLocalFlowsForEntity in interface LegacyFlowManager

Parameters:

entityName - - string name of the entity for the flow

Returns:

a list of Flows

getLocalFlowsForEntity

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

Description copied from interface: LegacyFlowManager

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

Specified by:

getLocalFlowsForEntity in interface LegacyFlowManager

Parameters:

entityName - - string name of the entity for the flow

flowType - - the FlowType enum, eg: ingest or harmonize

Returns:

a list of Flows

getFlowFromProperties

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

Description copied from interface: LegacyFlowManager

Obtains a flow from a property file

Specified by:

getFlowFromProperties in interface LegacyFlowManager

Parameters:

propertiesFile - - the Path to the property file

Returns:

- a flow object

getFlows

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

Description copied from interface: LegacyFlowManager

Retrieves a list of flows installed on the MarkLogic server

Specified by:

getFlows in interface LegacyFlowManager

Parameters:

entityName - - the entity from which to fetch the flows

Returns:

- a list of flows for the given entity

getFlow

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

Description copied from interface: LegacyFlowManager

Retrieves a named flow from a given entity

Specified by:

getFlow in interface LegacyFlowManager

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

Returns:

the flow

getFlow

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

Description copied from interface: LegacyFlowManager

Retrieves a named flow from a given entity

Specified by:

getFlow in interface LegacyFlowManager

Parameters:

entityName - - the entity that the flow belongs to

flowName - - the name of the flow to get

flowType - - the type of flow (ingest/harmonize)

Returns:

the flow

newFlowRunner

public LegacyFlowRunner newFlowRunner()

Description copied from interface: LegacyFlowManager

Creates and returns a new LegacyFlowRunner object using the FlowManager's hubconfig

Specified by:

newFlowRunner in interface LegacyFlowManager

Returns:

LegacyFlowRunner object with current hubconfig already set