com.ibm.broker.config.appdev.nodes

Class EmailInputNode

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


    public class EmailInputNode
    extends Node

    EmailInputNode instance

    EmailInput node retrieves an email from an email server supporting POP3 or IMAP

     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

      • EmailInputNode

        public EmailInputNode()
    • Method Detail

      • 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
      • setEmailServer

        public EmailInputNode setEmailServer(java.lang.String value)
        Set the EmailInputNode "Email server" property
        Parameters:
        value - String ; the value to set the property "Email server"
      • getEmailServer

        public java.lang.String getEmailServer()
        Get the EmailInputNode "Email server" property
        Returns:
        String; the value of the property "Email server"
      • setWaitInterval

        public EmailInputNode setWaitInterval(int value)
        Set the EmailInputNode "Polling interval (seconds)" property
        Parameters:
        value - int ; the value to set the property "Polling interval (seconds)"
      • getWaitInterval

        public int getWaitInterval()
        Get the EmailInputNode Polling interval (seconds) property
        Returns:
        int; the value of the property "Polling interval (seconds)"
      • setSecurityIdentity

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

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

        public EmailInputNode.ENUM_EMAILINPUT_RETRYMECHANISM getRetryMechanism()
        Get the EmailInputNode "Retry mechanism" property
        Returns:
        ENUM_EMAILINPUT_RETRYMECHANISM; the value of the property "Retry mechanism"
      • setRetryThreshold

        public EmailInputNode setRetryThreshold(int value)
        Set the EmailInputNode "Retry threshold" property
        Parameters:
        value - int ; the value to set the property "Retry threshold"
      • getRetryThreshold

        public int getRetryThreshold()
        Get the EmailInputNode Retry threshold property
        Returns:
        int; the value of the property "Retry threshold"
      • setShortRetryInterval

        public EmailInputNode setShortRetryInterval(int value)
        Set the EmailInputNode "Short retry interval (seconds)" property
        Parameters:
        value - int ; the value to set the property "Short retry interval (seconds)"
      • getShortRetryInterval

        public int getShortRetryInterval()
        Get the EmailInputNode Short retry interval (seconds) property
        Returns:
        int; the value of the property "Short retry interval (seconds)"
      • setLongRetryInterval

        public EmailInputNode setLongRetryInterval(int value)
        Set the EmailInputNode "Long retry interval (seconds)" property
        Parameters:
        value - int ; the value to set the property "Long retry interval (seconds)"
      • getLongRetryInterval

        public int getLongRetryInterval()
        Get the EmailInputNode Long retry interval (seconds) property
        Returns:
        int; the value of the property "Long retry interval (seconds)"
      • getEmailFailureAction

        public EmailInputNode.ENUM_EMAILINPUT_EMAILFAILUREACTION getEmailFailureAction()
        Get the EmailInputNode "Action on failing email" property
        Returns:
        ENUM_EMAILINPUT_EMAILFAILUREACTION; the value of the property "Action on failing email"
      • getTransactionMode

        public EmailInputNode.ENUM_EMAILINPUT_TRANSACTIONMODE getTransactionMode()
        Get the EmailInputNode "Transaction mode" property
        Returns:
        ENUM_EMAILINPUT_TRANSACTIONMODE; the value of the property "Transaction mode"
      • getComponentLevel

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

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

        public int getAdditionalInstances()
        Get the EmailInputNode 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