org.adroitlogic.x.core

Class IntegrationFlow

java.lang.Object

org.adroitlogic.x.core.IntegrationFlow

All Implemented Interfaces:

Identifiable, Initializable, Startable, MetricsReportable, XIntegrationFlow, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware

@AutoInitialize(initOrder=3)
 @AutoStart(startOrder=3)
 @MetricsReporter
public class IntegrationFlow
extends Object
implements XIntegrationFlow, MetricsReportable

The integration flow implementation that defines the execution flows which starts with an IngressConnectorElement and executes a set of associated XProcessingElement

Since:

17.01

Author:

Ruwan Linton

Field Summary

Fields

Modifier and Type	Field and Description
protected Status	status

Constructor Summary

Constructors

Constructor and Description
IntegrationFlow()

Method Summary

Modifier and Type	Method and Description
void	destroy()
String	getEntityId() Returns the entity ID to be used for metrics streams
String	getFlowFile()
String	getFlowFileName()
String	getFlowId() Returns the flow ID to be used for metrics streams
String	getId()
List<XIngressConnectorElement>	getIngressConnectors()
XMetricsEngine	getMetricsEngine() Retrieves the metrics engine to be used for this class
XProject	getProject() Retrieves the XProject to which this integration flow belongs to
String	getProjectId() Returns the project name to be used for metrics streams
String	getProjectVersion() Returns the project version to be used for metrics streams
Status	getStatus() Returns the current status of this Integration Flow
void	init(org.springframework.context.ApplicationContext context)
void	reportExecutionStatus(ExecutionResult executionResult) This method can be used to report the execution status of an Integration Flow for tasks such as metrics reporting
void	setBeanName(String s)
void	setFlowFile(String flowFile)
void	setFlowPath(File flowPath)
void	setProject(XProject project)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.x.api.metrics.MetricsReportable

getAdditionalProperties

Field Detail

status

protected volatile Status status

Constructor Detail

IntegrationFlow

public IntegrationFlow()

Method Detail

getId

public String getId()

Specified by:

getId in interface Identifiable

setBeanName

public void setBeanName(String s)

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

init

public void init(org.springframework.context.ApplicationContext context)

Specified by:

init in interface Initializable

start

public void start()

Specified by:

start in interface Startable

stop

public void stop()

Specified by:

stop in interface Startable

destroy

public void destroy()

Specified by:

destroy in interface Initializable

setFlowPath

public void setFlowPath(File flowPath)

setFlowFile

public void setFlowFile(String flowFile)

getFlowFile

public String getFlowFile()

getProject

public XProject getProject()

Retrieves the XProject to which this integration flow belongs to

Specified by:

getProject in interface XIntegrationFlow

Returns:

instance of XProject

getFlowFileName

public String getFlowFileName()

Specified by:

getFlowFileName in interface XIntegrationFlow

getIngressConnectors

public List<XIngressConnectorElement> getIngressConnectors()

Specified by:

getIngressConnectors in interface XIntegrationFlow

setProject

public void setProject(XProject project)

getMetricsEngine

public XMetricsEngine getMetricsEngine()

Description copied from interface: MetricsReportable

Retrieves the metrics engine to be used for this class

Specified by:

getMetricsEngine in interface MetricsReportable

Returns:

instance of XMetricsEngine

getEntityId

public String getEntityId()

Description copied from interface: MetricsReportable

Returns the entity ID to be used for metrics streams

Specified by:

getEntityId in interface MetricsReportable

Returns:

entity ID

getFlowId

public String getFlowId()

Description copied from interface: MetricsReportable

Returns the flow ID to be used for metrics streams

Specified by:

getFlowId in interface MetricsReportable

Returns:

flow ID

getProjectId

public String getProjectId()

Description copied from interface: MetricsReportable

Returns the project name to be used for metrics streams

Specified by:

getProjectId in interface MetricsReportable

Returns:

project name

getProjectVersion

public String getProjectVersion()

Description copied from interface: MetricsReportable

Returns the project version to be used for metrics streams

Specified by:

getProjectVersion in interface MetricsReportable

Returns:

project version

reportExecutionStatus

public void reportExecutionStatus(ExecutionResult executionResult)

Description copied from interface: XIntegrationFlow

This method can be used to report the execution status of an Integration Flow for tasks such as metrics reporting

Specified by:

reportExecutionStatus in interface XIntegrationFlow

Parameters:

executionResult - ExecutionResult of the integration flow

getStatus

public Status getStatus()

Description copied from interface: XIntegrationFlow

Returns the current status of this Integration Flow

Specified by:

getStatus in interface XIntegrationFlow

Returns:

Status