com.ibm.broker.config.appdev.nodes

Class KafkaConsumerNode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable


    public class KafkaConsumerNode
    extends Node

    KafkaConsumerNode instance

     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2010-08-10  dstorey         creation
     xxxxx.x  xxxx-xx-xx  generated       7.0.0.2 Release
     
    See Also:
    Serialized Form
    • Field Detail

      • OUTPUT_TERMINAL_CATCH

        public final OutputTerminal OUTPUT_TERMINAL_CATCH
      • OUTPUT_TERMINAL_FAILURE

        public final OutputTerminal OUTPUT_TERMINAL_FAILURE
      • OUTPUT_TERMINAL_OUT

        public final OutputTerminal OUTPUT_TERMINAL_OUT
    • Constructor Detail

      • KafkaConsumerNode

        public KafkaConsumerNode()
    • Method Detail

      • getParserXmlnscOpaqueElementsTable

        public KafkaConsumerNode.ParserXmlnscOpaqueElementsTable getParserXmlnscOpaqueElementsTable()
        Retrieve the Opaque elements table for the node KafkaConsumerNode
        Returns:
        ParserXmlnscOpaqueElementsTable instance which contains OpaqueElementsRow rows
      • getInputTerminals

        public InputTerminal[] getInputTerminals()
        Description copied from class: Node
        Gets the full list of available InputTerminals for this Node
        Specified by:
        getInputTerminals in class Node
        Returns:
        InputTerminal[]
      • getOutputTerminals

        public OutputTerminal[] getOutputTerminals()
        Description copied from class: Node
        Gets the full list of available OutputTerminals for this Node
        Specified by:
        getOutputTerminals in class Node
        Returns:
        OutputTerminal[]
      • getTypeName

        public java.lang.String getTypeName()
        Description copied from class: Node
        Gets the node type of this node
        Specified by:
        getTypeName in class Node
        Returns:
        String; the node type
      • setConnectorName

        public KafkaConsumerNode setConnectorName(java.lang.String value)
        Set the KafkaConsumerNode "ConnectorName" property
        Parameters:
        value - String ; the value to set the property "ConnectorName"
      • getConnectorName

        public java.lang.String getConnectorName()
        Get the KafkaConsumerNode "ConnectorName" property
        Returns:
        String; the value of the property "ConnectorName"
      • setTopicName

        public KafkaConsumerNode setTopicName(java.lang.String value)
        Set the KafkaConsumerNode "Topic name" property
        Parameters:
        value - String ; the value to set the property "Topic name"
      • getTopicName

        public java.lang.String getTopicName()
        Get the KafkaConsumerNode "Topic name" property
        Returns:
        String; the value of the property "Topic name"
      • setBootstrapServers

        public KafkaConsumerNode setBootstrapServers(java.lang.String value)
        Set the KafkaConsumerNode "Bootstrap servers" property
        Parameters:
        value - String ; the value to set the property "Bootstrap servers"
      • getBootstrapServers

        public java.lang.String getBootstrapServers()
        Get the KafkaConsumerNode "Bootstrap servers" property
        Returns:
        String; the value of the property "Bootstrap servers"
      • setGroupId

        public KafkaConsumerNode setGroupId(java.lang.String value)
        Set the KafkaConsumerNode "Consumer group ID" property
        Parameters:
        value - String ; the value to set the property "Consumer group ID"
      • getGroupId

        public java.lang.String getGroupId()
        Get the KafkaConsumerNode "Consumer group ID" property
        Returns:
        String; the value of the property "Consumer group ID"
      • getInitialOffset

        public KafkaConsumerNode.ENUM_KAFKACONSUMER_INITIALOFFSET getInitialOffset()
        Get the KafkaConsumerNode "Default message offset" property
        Returns:
        ENUM_KAFKACONSUMER_INITIALOFFSET; the value of the property "Default message offset"
      • setEnableAutoCommit

        public KafkaConsumerNode setEnableAutoCommit(boolean value)
        Set the KafkaConsumerNode "Commit message offset in Kafka" property
        Parameters:
        value - boolean ; the value to set the property "Commit message offset in Kafka"
      • getEnableAutoCommit

        public boolean getEnableAutoCommit()
        Get the KafkaConsumerNode "Commit message offset in Kafka" property
        Returns:
        boolean; the value of the property "Commit message offset in Kafka"
      • setClientId

        public KafkaConsumerNode setClientId(java.lang.String value)
        Set the KafkaConsumerNode "Client ID" property
        Parameters:
        value - String ; the value to set the property "Client ID"
      • getClientId

        public java.lang.String getClientId()
        Get the KafkaConsumerNode "Client ID" property
        Returns:
        String; the value of the property "Client ID"
      • setUseClientIdSuffix

        public KafkaConsumerNode setUseClientIdSuffix(boolean value)
        Set the KafkaConsumerNode "Add App Connect Enterprise suffix to client ID" property
        Parameters:
        value - boolean ; the value to set the property "Add App Connect Enterprise suffix to client ID"
      • getUseClientIdSuffix

        public boolean getUseClientIdSuffix()
        Get the KafkaConsumerNode "Add App Connect Enterprise suffix to client ID" property
        Returns:
        boolean; the value of the property "Add App Connect Enterprise suffix to client ID"
      • setConnectionTimeout

        public KafkaConsumerNode setConnectionTimeout(int value)
        Set the KafkaConsumerNode "Connection timeout (sec)" property
        Parameters:
        value - int ; the value to set the property "Connection timeout (sec)"
      • getConnectionTimeout

        public int getConnectionTimeout()
        Get the KafkaConsumerNode Connection timeout (sec) property
        Returns:
        int; the value of the property "Connection timeout (sec)"
      • setSessionTimeout

        public KafkaConsumerNode setSessionTimeout(int value)
        Set the KafkaConsumerNode "Session timeout (sec)" property
        Parameters:
        value - int ; the value to set the property "Session timeout (sec)"
      • getSessionTimeout

        public int getSessionTimeout()
        Get the KafkaConsumerNode Session timeout (sec) property
        Returns:
        int; the value of the property "Session timeout (sec)"
      • setReceiveBatchSize

        public KafkaConsumerNode setReceiveBatchSize(int value)
        Set the KafkaConsumerNode "Receive batch size" property
        Parameters:
        value - int ; the value to set the property "Receive batch size"
      • getReceiveBatchSize

        public int getReceiveBatchSize()
        Get the KafkaConsumerNode Receive batch size property
        Returns:
        int; the value of the property "Receive batch size"
      • setSslProtocol

        public KafkaConsumerNode setSslProtocol(java.lang.String value)
        Set the KafkaConsumerNode "SSL protocol" property
        Parameters:
        value - String ; the value to set the property "SSL protocol"
      • getSslProtocol

        public java.lang.String getSslProtocol()
        Get the KafkaConsumerNode "SSL protocol" property
        Returns:
        String; the value of the property "SSL protocol"
      • setSecurityIdentity

        public KafkaConsumerNode setSecurityIdentity(java.lang.String value)
        Set the KafkaConsumerNode "Security identity" property
        Parameters:
        value - String ; the value to set the property "Security identity"
      • getSecurityIdentity

        public java.lang.String getSecurityIdentity()
        Get the KafkaConsumerNode "Security identity" property
        Returns:
        String; the value of the property "Security identity"
      • setMessageDomainProperty

        public KafkaConsumerNode setMessageDomainProperty(java.lang.String value)
        Set the KafkaConsumerNode "Message domain" property
        Parameters:
        value - String ; the value to set the property "Message domain"
      • getMessageDomainProperty

        public java.lang.String getMessageDomainProperty()
        Get the KafkaConsumerNode "Message domain" property
        Returns:
        String; the value of the property "Message domain"
      • setMessageSetProperty

        public KafkaConsumerNode setMessageSetProperty(java.lang.String value)
        Set the KafkaConsumerNode "Message model" property
        Parameters:
        value - String ; the value to set the property "Message model"
      • getMessageSetProperty

        public java.lang.String getMessageSetProperty()
        Get the KafkaConsumerNode "Message model" property
        Returns:
        String; the value of the property "Message model"
      • setMessageTypeProperty

        public KafkaConsumerNode setMessageTypeProperty(java.lang.String value)
        Set the KafkaConsumerNode "Message" property
        Parameters:
        value - String ; the value to set the property "Message"
      • getMessageTypeProperty

        public java.lang.String getMessageTypeProperty()
        Get the KafkaConsumerNode "Message" property
        Returns:
        String; the value of the property "Message"
      • setMessageFormatProperty

        public KafkaConsumerNode setMessageFormatProperty(java.lang.String value)
        Set the KafkaConsumerNode "Physical format" property
        Parameters:
        value - String ; the value to set the property "Physical format"
      • getMessageFormatProperty

        public java.lang.String getMessageFormatProperty()
        Get the KafkaConsumerNode "Physical format" property
        Returns:
        String; the value of the property "Physical format"
      • setParserXmlnscBuildTreeUsingXMLSchema

        public KafkaConsumerNode setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
        Set the KafkaConsumerNode "Build tree using XML schema data types" property
        Parameters:
        value - boolean ; the value to set the property "Build tree using XML schema data types"
      • getParserXmlnscBuildTreeUsingXMLSchema

        public boolean getParserXmlnscBuildTreeUsingXMLSchema()
        Get the KafkaConsumerNode "Build tree using XML schema data types" property
        Returns:
        boolean; the value of the property "Build tree using XML schema data types"
      • setParserXmlnscUseForXmlnsDomain

        public KafkaConsumerNode setParserXmlnscUseForXmlnsDomain(boolean value)
        Set the KafkaConsumerNode "Use XMLNSC compact parser for XMLNS domain" property
        Parameters:
        value - boolean ; the value to set the property "Use XMLNSC compact parser for XMLNS domain"
      • getParserXmlnscUseForXmlnsDomain

        public boolean getParserXmlnscUseForXmlnsDomain()
        Get the KafkaConsumerNode "Use XMLNSC compact parser for XMLNS domain" property
        Returns:
        boolean; the value of the property "Use XMLNSC compact parser for XMLNS domain"
      • getComponentLevel

        public KafkaConsumerNode.ENUM_KAFKACONSUMER_COMPONENTLEVEL getComponentLevel()
        Get the KafkaConsumerNode "Additional instances pool" property
        Returns:
        ENUM_KAFKACONSUMER_COMPONENTLEVEL; the value of the property "Additional instances pool"
      • setAdditionalInstances

        public KafkaConsumerNode setAdditionalInstances(int value)
        Set the KafkaConsumerNode "Additional instances" property
        Parameters:
        value - int ; the value to set the property "Additional instances"
      • getAdditionalInstances

        public int getAdditionalInstances()
        Get the KafkaConsumerNode Additional instances property
        Returns:
        int; the value of the property "Additional instances"
      • getNodeName

        public java.lang.String getNodeName()
        Description copied from class: Node
        Gets the label name of this node
          MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow");
          Node inputMQNode = mf1.getNodeByName("My Input Node");
          inputMQNode.setNodeName("Renamed Input Node");
         
        Overrides:
        getNodeName in class Node
        Returns:
        String; the node name