Package com.tibco.ep.tcs.runtime.config

Class ModuleBlockMetaDataConfig

  • public class ModuleBlockMetaDataConfig
extends BlockMetaDataConfig

    Configuration that describes the metadata for a TCS module block.

    • Constructor Detail

      • ModuleBlockMetaDataConfig

        public ModuleBlockMetaDataConfig()

        Create a new empty module block metadata object.

    • Method Detail

      • getFullyQualifiedEntryPointModuleName

        public String getFullyQualifiedEntryPointModuleName()

        Return the fully-qualified name of the underlying EventFlow module that serves as the block's entry point.

        Returns:
        entry point module

      • setFullyQualifiedEntryPointModuleName

        public ModuleBlockMetaDataConfig setFullyQualifiedEntryPointModuleName​(String fullyQualifiedEntryPointModuleName)

        Set the fully-qualified name of the underlying EventFlow module that serves as the block's entry point.

        Parameters:
        fullyQualifiedEntryPointModuleName - entry module
        Returns:
        this object

      • getParameterTransformations

        public List<TransformationConfig> getParameterTransformations()

        Return a list of transformations to produce module- or container-scope parameters, null if none.

        Returns:
        parameter transformations, null if none.

      • setParameterTransformations

        public ModuleBlockMetaDataConfig setParameterTransformations​(List<TransformationConfig> parameterTransformations)

        Set a list of transformations to produce module- or container-scope parameters, null if none.

        Parameters:
        parameterTransformations - null if none transformation list
        Returns:
        this object

      • addParameterTransformation

        public ModuleBlockMetaDataConfig addParameterTransformation​(TransformationConfig parameterTransformation)

        Add a parameter transformation. Cannot be null.

        Parameters:
        parameterTransformation - transformation to add
        Returns:
        this object

      • getInputPorts

        public Map<String,​ModuleBlockPortConfig> getInputPorts()

        Return this block's map of input ports, indexed by port name.

        Returns:
        input ports

      • addInputPort

        public ModuleBlockMetaDataConfig addInputPort​(String portName,
                                              ModuleBlockPortConfig portConfig)

        Add an input port name and associated configuration. Neither can be null.

        Parameters:
        portName - port name
        portConfig - 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

      • addOutputPort

        public ModuleBlockMetaDataConfig addOutputPort​(String portName,
                                               ModuleBlockPortConfig portConfig)

        Add an output port name and associated configuration. Neither can be null.

        Parameters:
        portName - port name
        portConfig - port configuration
        Returns:
        this object

      • setConfigurationSchema

        public ModuleBlockMetaDataConfig setConfigurationSchema​(String configurationSchema)

        Set the schema that describes and validates configuration for this block, expressed as a fully-qualified class path resource.

        Overrides:
        setConfigurationSchema in class BlockMetaDataConfig
        Parameters:
        configurationSchema - schema
        Returns:
        this object