IntegrationFlow (AdroitLogic Project-X 17.07.5 API)

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

Fields
Modifier and Type	Field and Description
`protected Status`	`status`

Constructor Summary

Constructors
Constructor and Description

IntegrationFlow()

Constructors
Constructor and Description
`IntegrationFlow()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decrementOnTheFlyMsgCount()` Atomically decrement the current on the fly message count of the integration flow by 1, and notify the new value to the registered message count change subscribers if any.
`void`	`destroy()`
`List<XEgressConnectorElement>`	`getEgressConnectors()` Retrieves the egress connectors belongs to this integration flow
`String`	`getEntityId()` Returns the entity ID to be used for metrics streams
`String`	`getFlowFile()`
`String`	`getFlowFileName()` Retrieves the name of the file in which this integration flow is defined
`String`	`getFlowId()` Returns the flow ID to be used for metrics streams
`String`	`getId()`
`List<XIngressConnectorElement>`	`getIngressConnectors()` Retrieves the ingress connectors belongs to this integration flow
`XMetricsEngine`	`getMetricsEngine()` Retrieves the metrics engine to be used for this class
`int`	`getOnTheFlyMessageCount()` Retrieves the current on the fly message count of this integration flow
`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
`File`	`getxPosFile()`
`void`	`incrementOnTheFlyMsgCount()` Atomically increment the current on the fly message count of the integration flow by 1, and notify the new value to the registered message count change subscribers if any.
`void`	`init(org.springframework.context.ApplicationContext context)`
`void`	`registerForMessageCountChange(Consumer<Integer> consumer, boolean sendCurrentCountEvent)` This method can be used to register a subscriber to the on the fly message count changes of the integration flow
`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`	`setxPosFile(File xPosFile)`
`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()
```
    Description copied from interface: XIntegrationFlow
    
    Retrieves the name of the file in which this integration flow is defined
    
    Specified by:
    
    getFlowFileName in interface XIntegrationFlow
    
    Returns:
    
    the file name as String
  - getIngressConnectors
```
public List<XIngressConnectorElement> getIngressConnectors()
```
    Description copied from interface: XIntegrationFlow
    
    Retrieves the ingress connectors belongs to this integration flow
    
    Specified by:
    
    getIngressConnectors in interface XIntegrationFlow
    
    Returns:
    
    a list of XIngressConnectorElement
  - getEgressConnectors
```
public List<XEgressConnectorElement> getEgressConnectors()
```
    Description copied from interface: XIntegrationFlow
    
    Retrieves the egress connectors belongs to this integration flow
    
    Specified by:
    
    getEgressConnectors in interface XIntegrationFlow
    
    Returns:
    
    a list of XEgressConnectorElement
  - 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
  - registerForMessageCountChange
```
public void registerForMessageCountChange(Consumer<Integer> consumer,
                                          boolean sendCurrentCountEvent)
```
    Description copied from interface: XIntegrationFlow
    
    This method can be used to register a subscriber to the on the fly message count changes of the integration flow
    
    Specified by:
    
    registerForMessageCountChange in interface XIntegrationFlow
    
    Parameters:
    
    consumer - a consumer that accepts Integer values. Each time the on-the-fly message count changes, this consumer will be executed with the new message count
    
    sendCurrentCountEvent - whether to send the on-the-fly message count at the time of the registration
  - incrementOnTheFlyMsgCount
```
public void incrementOnTheFlyMsgCount()
```
    Description copied from interface: XIntegrationFlow
    
    Atomically increment the current on the fly message count of the integration flow by 1, and notify the new value to the registered message count change subscribers if any.
    
    Specified by:
    
    incrementOnTheFlyMsgCount in interface XIntegrationFlow
  - decrementOnTheFlyMsgCount
```
public void decrementOnTheFlyMsgCount()
```
    Description copied from interface: XIntegrationFlow
    
    Atomically decrement the current on the fly message count of the integration flow by 1, and notify the new value to the registered message count change subscribers if any.
    
    Specified by:
    
    decrementOnTheFlyMsgCount in interface XIntegrationFlow
  - getOnTheFlyMessageCount
```
public int getOnTheFlyMessageCount()
```
    Description copied from interface: XIntegrationFlow
    
    Retrieves the current on the fly message count of this integration flow
    
    Specified by:
    
    getOnTheFlyMessageCount in interface XIntegrationFlow
    
    Returns:
    
    current on the fly message count
  - getxPosFile
```
public File getxPosFile()
```
  - setxPosFile
```
public void setxPosFile(File xPosFile)
```

Class IntegrationFlow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

status

Constructor Detail

IntegrationFlow

Method Detail

getId

setBeanName

init

start

stop

destroy

setFlowPath

setFlowFile

getFlowFile

getProject

getFlowFileName

getIngressConnectors

getEgressConnectors

setProject

getMetricsEngine

getEntityId

getFlowId

getProjectId

getProjectVersion

reportExecutionStatus

getStatus

registerForMessageCountChange

incrementOnTheFlyMsgCount

decrementOnTheFlyMsgCount

getOnTheFlyMessageCount

getxPosFile

setxPosFile