org.adroitlogic.x.base.util

Class FlowValidationUtil

java.lang.Object

org.adroitlogic.x.base.util.FlowValidationUtil

public class FlowValidationUtil
extends Object

Utility class to provide useful functionality when writing Integration Flow Validators

Since:

17.01

Author:

Sajith Dilshan

Constructor Summary

Constructors

Constructor and Description
FlowValidationUtil()

Method Summary

Modifier and Type	Method and Description
static Optional<? extends XProcessingElement>	findElementInCompletePath(XProcessingElement processingElement, Class<? extends XProcessingElement> elementClazz) This method can be used to find a given XProcessingElement type is present in the complete out-going path (including "On Exception" out ports) of the specified XProcessingElement instance.
static Optional<? extends XProcessingElement>	findElementInNonExceptionalPath(XProcessingElement processingElement, Class<? extends XProcessingElement> elementClazz) This method can be used to find a given XProcessingElement type is present in the out-going path of the specified XProcessingElement instance.
static Map<String,List<XProcessingElement>>	getMultipleOutPortElements(XProcessingElement processingElement) This method can be used to obtain a Map of List of XProcessingElements of OutPort annotated fields in the given XProcessingElement object which accept a List of XProcessingElements.
static Map<String,XProcessingElement>	getOutPortElements(XProcessingElement processingElement) This method can be used to obtain a XProcessingElement Map of OutPort annotated fields which only accept one XProcessingElement in the given XProcessingElement object.
static Map<String,Object>	getParameters(XConnectorOperationElement connectorOperationElement) This method can be used to obtain a Map of list of Parameter annotated fields in the given XConnectorOperationElement object where the key of the map would be the field name and the value would be the initialized value for that particular field.
static Map<String,Object>	getParameters(XProcessingElement processingElement) This method can be used to obtain a Map of list of Parameter annotated fields in the given XProcessingElement object where the key of the map would be the field name and the value would be the initialized value for that particular field.
static Map<String,Object>	getSidePortElements(XProcessingElement processingElement) This method can be used to obtain a Object Map of BeanRef annotated fields in the given XProcessingElement object.
static boolean	isFlowComplete(IngressConnectorElement ingressConnector)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowValidationUtil

public FlowValidationUtil()

Method Detail

getOutPortElements

public static Map<String,XProcessingElement> getOutPortElements(XProcessingElement processingElement)

This method can be used to obtain a XProcessingElement Map of OutPort annotated fields which only accept one XProcessingElement in the given XProcessingElement object. The key of the map is the name of the field and the value is the XProcessingElement connected to that out port.

It should be noted that, this will only consider OutPorts that accept exactly one XProcessingElement and out of those this map will contain an entry for a particular OutPort annotated field, iff that field is initialized with a non-null value. i.e only when that out port is connected to another XProcessingElement.

Parameters:

processingElement - Instance of XProcessingElement where the OutPort annotated fields should be returned.

Returns:

a Map which contains XProcessingElement for each connected out port

getMultipleOutPortElements

public static Map<String,List<XProcessingElement>> getMultipleOutPortElements(XProcessingElement processingElement)

This method can be used to obtain a Map of List of XProcessingElements of OutPort annotated fields in the given XProcessingElement object which accept a List of XProcessingElements. The key of the map is the name of the field and the value is the list of XProcessingElements connected to that out port.

It should be noted that, this will only consider OutPorts that accept a List of XProcessingElements and out of those this map will contain an entry for a particular OutPort annotated field, iff that field is initialized with a non-null value. i.e only when that out port is connected to at least one another XProcessingElement.

Parameters:

processingElement - Instance of XProcessingElement where the OutPort annotated fields should be returned.

Returns:

a Map which contains List of XProcessingElements for each connected out port

getSidePortElements

public static Map<String,Object> getSidePortElements(XProcessingElement processingElement)

This method can be used to obtain a Object Map of BeanRef annotated fields in the given XProcessingElement object. The key of the map is the name of the fields and the value is the Object which is referred by the bean reference (connected to the side port)

It should be noted that, this map will contain an entry for a particular BeanRef annotated field, iff that field in initialized with a non-null value. i.e. only when that side port is connected to another element.

Parameters:

processingElement - Instance of XProcessingElement where the BeanRef annotated fields should be returned.

Returns:

a Map which contains Object for each connected side port

getParameters

public static Map<String,Object> getParameters(XProcessingElement processingElement)

This method can be used to obtain a Map of list of Parameter annotated fields in the given XProcessingElement object where the key of the map would be the field name and the value would be the initialized value for that particular field.

It should be noted that, this Map will contains ONLY field which are initialized with a non null value.

Parameters:

processingElement - Instance of XProcessingElement where the Parameter annotated fields should be returned.

Returns:

a HashMap where the key would be String and the value is of type Object

getParameters

public static Map<String,Object> getParameters(XConnectorOperationElement connectorOperationElement)

This method can be used to obtain a Map of list of Parameter annotated fields in the given XConnectorOperationElement object where the key of the map would be the field name and the value would be the initialized value for that particular field.

It should be noted that, this Map will contains ONLY field which are initialized with a non null value.

Parameters:

connectorOperationElement - Instance of XConnectorOperationElement where the Parameter annotated fields should be returned

Returns:

a HashMap where the key would be String and the value is of type Object

findElementInNonExceptionalPath

public static Optional<? extends XProcessingElement> findElementInNonExceptionalPath(XProcessingElement processingElement,
                                                                                     Class<? extends XProcessingElement> elementClazz)

This method can be used to find a given XProcessingElement type is present in the out-going path of the specified XProcessingElement instance.

It should be noted that when checking the out-going path, this method will skip all the paths constructed via elements connected to "On Exception" out port.

Parameters:

processingElement - XProcessingElement instance where the out-going path should be inspected for a particular XProcessingElement type object

elementClazz - class of the XProcessingElement object which should be present in the out-going path

Returns:

an Optional instance which wraps the required type of XProcessingElement

findElementInCompletePath

public static Optional<? extends XProcessingElement> findElementInCompletePath(XProcessingElement processingElement,
                                                                               Class<? extends XProcessingElement> elementClazz)

This method can be used to find a given XProcessingElement type is present in the complete out-going path (including "On Exception" out ports) of the specified XProcessingElement instance.

Parameters:

processingElement - XProcessingElement instance where the out-going path should be inspected for a particular XProcessingElement type object

elementClazz - class of the XProcessingElement object which should be present in the out-going path

Returns:

an Optional instance which wraps the required type of XProcessingElement

isFlowComplete

public static boolean isFlowComplete(IngressConnectorElement ingressConnector)