com.ibm.broker.config.appdev.nodes

Class TCPIPClientReceiveNode

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


    public class TCPIPClientReceiveNode
    extends Node

    TCPIPClientReceiveNode instance

    The TCPIPClientReceive node receives data, in the middle of a message flow, over a TCPIP connection initiated by App Connect Enterprise

     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

      • INPUT_TERMINAL_IN

        public final InputTerminal INPUT_TERMINAL_IN
      • OUTPUT_TERMINAL_TIMEOUT

        public final OutputTerminal OUTPUT_TERMINAL_TIMEOUT
      • OUTPUT_TERMINAL_FAILURE

        public final OutputTerminal OUTPUT_TERMINAL_FAILURE
      • OUTPUT_TERMINAL_OUT

        public final OutputTerminal OUTPUT_TERMINAL_OUT
    • Constructor Detail

      • TCPIPClientReceiveNode

        public TCPIPClientReceiveNode()
    • Method Detail

      • getParserXmlnscOpaqueElementsTable

        public TCPIPClientReceiveNode.ParserXmlnscOpaqueElementsTable getParserXmlnscOpaqueElementsTable()
        Retrieve the Opaque elements table for the node TCPIPClientReceiveNode
        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
      • setConnectionDetails

        public TCPIPClientReceiveNode setConnectionDetails(java.lang.String value)
        Set the TCPIPClientReceiveNode "Connection details" property
        Parameters:
        value - String ; the value to set the property "Connection details"
      • getConnectionDetails

        public java.lang.String getConnectionDetails()
        Get the TCPIPClientReceiveNode "Connection details" property
        Returns:
        String; the value of the property "Connection details"
      • setTimeoutWaitingForData

        public TCPIPClientReceiveNode setTimeoutWaitingForData(int value)
        Set the TCPIPClientReceiveNode "Timeout waiting for data record (seconds)" property
        Parameters:
        value - int ; the value to set the property "Timeout waiting for data record (seconds)"
      • getTimeoutWaitingForData

        public int getTimeoutWaitingForData()
        Get the TCPIPClientReceiveNode Timeout waiting for data record (seconds) property
        Returns:
        int; the value of the property "Timeout waiting for data record (seconds)"
      • setCloseInputStream

        public TCPIPClientReceiveNode setCloseInputStream(boolean value)
        Set the TCPIPClientReceiveNode "Close input stream after a record has been received" property
        Parameters:
        value - boolean ; the value to set the property "Close input stream after a record has been received"
      • getCloseInputStream

        public boolean getCloseInputStream()
        Get the TCPIPClientReceiveNode "Close input stream after a record has been received" property
        Returns:
        boolean; the value of the property "Close input stream after a record has been received"
      • setHostnameLocation

        public TCPIPClientReceiveNode setHostnameLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Hostname location" property
        Parameters:
        value - String ; the value to set the property "Hostname location"
      • getHostnameLocation

        public java.lang.String getHostnameLocation()
        Get the TCPIPClientReceiveNode "Hostname location" property
        Returns:
        String; the value of the property "Hostname location"
      • setPortLocation

        public TCPIPClientReceiveNode setPortLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Port location" property
        Parameters:
        value - String ; the value to set the property "Port location"
      • getPortLocation

        public java.lang.String getPortLocation()
        Get the TCPIPClientReceiveNode "Port location" property
        Returns:
        String; the value of the property "Port location"
      • setIdLocation

        public TCPIPClientReceiveNode setIdLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "ID location" property
        Parameters:
        value - String ; the value to set the property "ID location"
      • getIdLocation

        public java.lang.String getIdLocation()
        Get the TCPIPClientReceiveNode "ID location" property
        Returns:
        String; the value of the property "ID location"
      • setReplyIdLocation

        public TCPIPClientReceiveNode setReplyIdLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Reply ID location" property
        Parameters:
        value - String ; the value to set the property "Reply ID location"
      • getReplyIdLocation

        public java.lang.String getReplyIdLocation()
        Get the TCPIPClientReceiveNode "Reply ID location" property
        Returns:
        String; the value of the property "Reply ID location"
      • setTimeoutLocation

        public TCPIPClientReceiveNode setTimeoutLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Timeout location" property
        Parameters:
        value - String ; the value to set the property "Timeout location"
      • getTimeoutLocation

        public java.lang.String getTimeoutLocation()
        Get the TCPIPClientReceiveNode "Timeout location" property
        Returns:
        String; the value of the property "Timeout location"
      • setLengthLocation

        public TCPIPClientReceiveNode setLengthLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Record length location" property
        Parameters:
        value - String ; the value to set the property "Record length location"
      • getLengthLocation

        public java.lang.String getLengthLocation()
        Get the TCPIPClientReceiveNode "Record length location" property
        Returns:
        String; the value of the property "Record length location"
      • setOutputDataLocation

        public TCPIPClientReceiveNode setOutputDataLocation(java.lang.String value)
        Set the TCPIPClientReceiveNode "Output data location" property
        Parameters:
        value - String ; the value to set the property "Output data location"
      • getOutputDataLocation

        public java.lang.String getOutputDataLocation()
        Get the TCPIPClientReceiveNode "Output data location" property
        Returns:
        String; the value of the property "Output data location"
      • setCopyLocalEnvironment

        public TCPIPClientReceiveNode setCopyLocalEnvironment(boolean value)
        Set the TCPIPClientReceiveNode "Copy local environment" property
        Parameters:
        value - boolean ; the value to set the property "Copy local environment"
      • getCopyLocalEnvironment

        public boolean getCopyLocalEnvironment()
        Get the TCPIPClientReceiveNode "Copy local environment" property
        Returns:
        boolean; the value of the property "Copy local environment"
      • setMessageDomainProperty

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

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

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

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

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

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

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

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

        public TCPIPClientReceiveNode setMessageCodedCharSetIdProperty(java.lang.String value)
        Set the TCPIPClientReceiveNode "Message coded character set ID" property
        Parameters:
        value - String ; the value to set the property "Message coded character set ID"
      • getMessageCodedCharSetIdProperty

        public java.lang.String getMessageCodedCharSetIdProperty()
        Get the TCPIPClientReceiveNode "Message coded character set ID" property
        Returns:
        String; the value of the property "Message coded character set ID"
      • setMessageEncodingProperty

        public TCPIPClientReceiveNode setMessageEncodingProperty(java.lang.String value)
        Set the TCPIPClientReceiveNode "Message encoding" property
        Parameters:
        value - String ; the value to set the property "Message encoding"
      • getMessageEncodingProperty

        public java.lang.String getMessageEncodingProperty()
        Get the TCPIPClientReceiveNode "Message encoding" property
        Returns:
        String; the value of the property "Message encoding"
      • setParserXmlnscBuildTreeUsingXMLSchema

        public TCPIPClientReceiveNode setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
        Set the TCPIPClientReceiveNode "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 TCPIPClientReceiveNode "Build tree using XML schema data types" property
        Returns:
        boolean; the value of the property "Build tree using XML schema data types"
      • setParserXmlnscUseForXmlnsDomain

        public TCPIPClientReceiveNode setParserXmlnscUseForXmlnsDomain(boolean value)
        Set the TCPIPClientReceiveNode "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 TCPIPClientReceiveNode "Use XMLNSC compact parser for XMLNS domain" property
        Returns:
        boolean; the value of the property "Use XMLNSC compact parser for XMLNS domain"
      • setRecordLength

        public TCPIPClientReceiveNode setRecordLength(int value)
        Set the TCPIPClientReceiveNode "Length (bytes)" property
        Parameters:
        value - int ; the value to set the property "Length (bytes)"
      • getRecordLength

        public int getRecordLength()
        Get the TCPIPClientReceiveNode Length (bytes) property
        Returns:
        int; the value of the property "Length (bytes)"
      • setCustomDelimiter

        public TCPIPClientReceiveNode setCustomDelimiter(java.lang.String value)
        Set the TCPIPClientReceiveNode "Custom delimiter (hexadecimal)" property
        Parameters:
        value - String ; the value to set the property "Custom delimiter (hexadecimal)"
      • getCustomDelimiter

        public java.lang.String getCustomDelimiter()
        Get the TCPIPClientReceiveNode "Custom delimiter (hexadecimal)" property
        Returns:
        String; the value of the property "Custom delimiter (hexadecimal)"
      • 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