Class CallFlowBlockMetaDataConfig
- java.lang.Object
-
- com.tibco.ep.tcs.runtime.config.BaseConfig
-
- com.tibco.ep.tcs.runtime.config.BlockMetaDataConfig
-
- com.tibco.ep.tcs.runtime.config.CallFlowBlockMetaDataConfig
-
public class CallFlowBlockMetaDataConfig extends BlockMetaDataConfig
Configuration that describes the metadata for a TCS call-flow block.
-
-
Field Summary
-
Fields inherited from class com.tibco.ep.tcs.runtime.config.BlockMetaDataConfig
CONFIGURATION_SCHEMA_PROP
-
-
Constructor Summary
Constructors Constructor Description CallFlowBlockMetaDataConfig()Create a new empty module block metadata object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CallFlowBlockMetaDataConfigaddInputPort(String portName, ModuleBlockPortConfig portConfig)Add an input port name and associated configuration.CallFlowBlockMetaDataConfigaddOutputPort(String portName, ModuleBlockPortConfig portConfig)Add an output port name and associated configuration.CallFlowBlockMetaDataConfigaddSubstitutionVariableTransformation(TransformationConfig substitutionVariableTransformation)Add a substitution variable transformation.protected voidfillMap(Map<String,Object> props)Add this object's properties to the specified map.StringgetFullyQualifiedFlowResourceName()Return the fully-qualified name of the flow configuration that this block will call.Map<String,ModuleBlockPortConfig>getInputPorts()Return this block's map of input ports, indexed by port name.Map<String,ModuleBlockPortConfig>getOutputPorts()Return this block's map of output ports, indexed by port name, null if none.List<TransformationConfig>getSubstitutionVariableTransformations()Return a list of transformations to produce substitution variable values referenced by the attached HOCON configurations, null if none.CallFlowBlockMetaDataConfigsetConfigurationSchema(String configurationSchema)Set the schema that describes and validates configuration for this block, expressed as a fully-qualified class path resource.CallFlowBlockMetaDataConfigsetFullyQualifiedFlowResourceName(String fullyQualifiedFlowResourceName)Set the fully-qualified name of the flow configuration that this block will call.CallFlowBlockMetaDataConfigsetInputPorts(Map<String,ModuleBlockPortConfig> inputPorts)Set this block's map of input ports, indexed by port name.CallFlowBlockMetaDataConfigsetOutputPorts(Map<String,ModuleBlockPortConfig> outputPorts)Set this block's map of output ports, indexed by port name, null if none.CallFlowBlockMetaDataConfigsetSubstitutionVariableTransformations(List<TransformationConfig> substitutionVariableTransformations)Set a list of transformations to produce substitution variable values referenced by the attached HOCON configurations, null if none.-
Methods inherited from class com.tibco.ep.tcs.runtime.config.BlockMetaDataConfig
getConfigurationSchema
-
Methods inherited from class com.tibco.ep.tcs.runtime.config.BaseConfig
toHOCON
-
-
-
-
Method Detail
-
getFullyQualifiedFlowResourceName
public String getFullyQualifiedFlowResourceName()
Return the fully-qualified name of the flow configuration that this block will call.
- Returns:
- flow FQN
-
setFullyQualifiedFlowResourceName
public CallFlowBlockMetaDataConfig setFullyQualifiedFlowResourceName(String fullyQualifiedFlowResourceName)
Set the fully-qualified name of the flow configuration that this block will call.
- Parameters:
fullyQualifiedFlowResourceName- flow FQN- Returns:
- this object
-
getInputPorts
public Map<String,ModuleBlockPortConfig> getInputPorts()
Return this block's map of input ports, indexed by port name.
- Returns:
- input ports
-
setInputPorts
public CallFlowBlockMetaDataConfig setInputPorts(Map<String,ModuleBlockPortConfig> inputPorts)
Set this block's map of input ports, indexed by port name.
- Parameters:
inputPorts- port map- Returns:
- this object
-
addInputPort
public CallFlowBlockMetaDataConfig addInputPort(String portName, ModuleBlockPortConfig portConfig)
Add an input port name and associated configuration. Neither can be null.
- Parameters:
portName- port nameportConfig- port configuration- Returns:
- this object
-
getOutputPorts
public Map<String,ModuleBlockPortConfig> getOutputPorts()
Return this block's map of output ports, indexed by port name, null if none.
- Returns:
- output ports, null if none
-
setOutputPorts
public CallFlowBlockMetaDataConfig setOutputPorts(Map<String,ModuleBlockPortConfig> outputPorts)
Set this block's map of output ports, indexed by port name, null if none.
- Parameters:
outputPorts- port map, null if none- Returns:
- this object
-
addOutputPort
public CallFlowBlockMetaDataConfig addOutputPort(String portName, ModuleBlockPortConfig portConfig)
Add an output port name and associated configuration. Neither can be null.
- Parameters:
portName- port nameportConfig- port configuration- Returns:
- this object
-
getSubstitutionVariableTransformations
public List<TransformationConfig> getSubstitutionVariableTransformations()
Return a list of transformations to produce substitution variable values referenced by the attached HOCON configurations, null if none.
- Returns:
- substitution variable transformations
-
setSubstitutionVariableTransformations
public CallFlowBlockMetaDataConfig setSubstitutionVariableTransformations(List<TransformationConfig> substitutionVariableTransformations)
Set a list of transformations to produce substitution variable values referenced by the attached HOCON configurations, null if none.
- Parameters:
substitutionVariableTransformations- substitution variable transformations, null if none- Returns:
- this object
-
addSubstitutionVariableTransformation
public CallFlowBlockMetaDataConfig addSubstitutionVariableTransformation(TransformationConfig substitutionVariableTransformation)
Add a substitution variable transformation. Cannot be null.
- Parameters:
substitutionVariableTransformation- transformation to add- Returns:
- this object
-
setConfigurationSchema
public CallFlowBlockMetaDataConfig setConfigurationSchema(String configurationSchema)
Set the schema that describes and validates configuration for this block, expressed as a fully-qualified class path resource.
- Overrides:
setConfigurationSchemain classBlockMetaDataConfig- Parameters:
configurationSchema- schema- Returns:
- this object
-
fillMap
protected void fillMap(Map<String,Object> props)
Add this object's properties to the specified map.
- Overrides:
fillMapin classBlockMetaDataConfig- Parameters:
props- map to fill
-
-