com.ibm.broker.config.appdev.nodes

Class FileInputNode

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


    public class FileInputNode
    extends Node

    FileInputNode instance

    FileInput node retrieves data from a local or remote file system

     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
    • Constructor Detail

      • FileInputNode

        public FileInputNode()
    • Method Detail

      • getParserXmlnscOpaqueElementsTable

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

        public FileInputNode setInputDirectory(java.lang.String value)
        Set the FileInputNode "Input directory" property
        Parameters:
        value - String ; the value to set the property "Input directory"
      • getInputDirectory

        public java.lang.String getInputDirectory()
        Get the FileInputNode "Input directory" property
        Returns:
        String; the value of the property "Input directory"
      • setRecursiveDirectories

        public FileInputNode setRecursiveDirectories(boolean value)
        Set the FileInputNode "Include local subdirectories" property
        Parameters:
        value - boolean ; the value to set the property "Include local subdirectories"
      • getRecursiveDirectories

        public boolean getRecursiveDirectories()
        Get the FileInputNode "Include local subdirectories" property
        Returns:
        boolean; the value of the property "Include local subdirectories"
      • setFilenamePattern

        public FileInputNode setFilenamePattern(java.lang.String value)
        Set the FileInputNode "File name or pattern" property
        Parameters:
        value - String ; the value to set the property "File name or pattern"
      • getFilenamePattern

        public java.lang.String getFilenamePattern()
        Get the FileInputNode "File name or pattern" property
        Returns:
        String; the value of the property "File name or pattern"
      • setExcludePattern

        public FileInputNode setExcludePattern(java.lang.String value)
        Set the FileInputNode "File exclusion pattern" property
        Parameters:
        value - String ; the value to set the property "File exclusion pattern"
      • getExcludePattern

        public java.lang.String getExcludePattern()
        Get the FileInputNode "File exclusion pattern" property
        Returns:
        String; the value of the property "File exclusion pattern"
      • setProcessedFileAction

        public FileInputNode setProcessedFileAction(FileInputNode.ENUM_FILEINPUT_PROCESSEDFILEACTION value)
        Set the FileInputNode "Action on successful processing" property
        Parameters:
        value - ENUM_FILEINPUT_PROCESSEDFILEACTION ; the value to set the property "Action on successful processing"
      • getProcessedFileAction

        public FileInputNode.ENUM_FILEINPUT_PROCESSEDFILEACTION getProcessedFileAction()
        Get the FileInputNode "Action on successful processing" property
        Returns:
        ENUM_FILEINPUT_PROCESSEDFILEACTION; the value of the property "Action on successful processing"
      • setReplaceDuplicateArchives

        public FileInputNode setReplaceDuplicateArchives(boolean value)
        Set the FileInputNode "Replace duplicate archive files" property
        Parameters:
        value - boolean ; the value to set the property "Replace duplicate archive files"
      • getReplaceDuplicateArchives

        public boolean getReplaceDuplicateArchives()
        Get the FileInputNode "Replace duplicate archive files" property
        Returns:
        boolean; the value of the property "Replace duplicate archive files"
      • setMessageDomainProperty

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

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

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

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

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

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

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

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

        public FileInputNode setMessageCodedCharSetIdProperty(java.lang.String value)
        Set the FileInputNode "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 FileInputNode "Message coded character set ID" property
        Returns:
        String; the value of the property "Message coded character set ID"
      • setMessageEncodingProperty

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

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

        public FileInputNode.ENUM_FILEINPUT_VALIDATETIMING getValidateTiming()
        Get the FileInputNode "Parse timing" property
        Returns:
        ENUM_FILEINPUT_VALIDATETIMING; the value of the property "Parse timing"
      • setParserXmlnscBuildTreeUsingXMLSchema

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

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

        public FileInputNode.ENUM_FILEINPUT_PARSERXMLNSCMIXEDCONTENTRETAINMODE getParserXmlnscMixedContentRetainMode()
        Get the FileInputNode "Retain mixed content" property
        Returns:
        ENUM_FILEINPUT_PARSERXMLNSCMIXEDCONTENTRETAINMODE; the value of the property "Retain mixed content"
      • getParserXmlnscProcessingInstructionsRetainMode

        public FileInputNode.ENUM_FILEINPUT_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE getParserXmlnscProcessingInstructionsRetainMode()
        Get the FileInputNode "Retain processing instructions" property
        Returns:
        ENUM_FILEINPUT_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE; the value of the property "Retain processing instructions"
      • setWaitInterval

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

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

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

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

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

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

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

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

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

        public FileInputNode.ENUM_FILEINPUT_FAILEDFILEACTION getFailedFileAction()
        Get the FileInputNode "Action on failing file" property
        Returns:
        ENUM_FILEINPUT_FAILEDFILEACTION; the value of the property "Action on failing file"
      • getRecordDetection

        public FileInputNode.ENUM_FILEINPUT_RECORDDETECTION getRecordDetection()
        Get the FileInputNode "Record detection" property
        Returns:
        ENUM_FILEINPUT_RECORDDETECTION; the value of the property "Record detection"
      • setSkipFirstRecord

        public FileInputNode setSkipFirstRecord(boolean value)
        Set the FileInputNode "Skip first record" property
        Parameters:
        value - boolean ; the value to set the property "Skip first record"
      • getSkipFirstRecord

        public boolean getSkipFirstRecord()
        Get the FileInputNode "Skip first record" property
        Returns:
        boolean; the value of the property "Skip first record"
      • setRecordLength

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

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

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

        public java.lang.String getCustomDelimiter()
        Get the FileInputNode "Custom delimiter (hexadecimal)" property
        Returns:
        String; the value of the property "Custom delimiter (hexadecimal)"
      • getDelimiterType

        public FileInputNode.ENUM_FILEINPUT_DELIMITERTYPE getDelimiterType()
        Get the FileInputNode "Delimiter type" property
        Returns:
        ENUM_FILEINPUT_DELIMITERTYPE; the value of the property "Delimiter type"
      • getValidateFailureAction

        public FileInputNode.ENUM_FILEINPUT_VALIDATEFAILUREACTION getValidateFailureAction()
        Get the FileInputNode "Failure action" property
        Returns:
        ENUM_FILEINPUT_VALIDATEFAILUREACTION; the value of the property "Failure action"
      • setFileFtp

        public FileInputNode setFileFtp(boolean value)
        Set the FileInputNode "Remote Transfer" property
        Parameters:
        value - boolean ; the value to set the property "Remote Transfer"
      • getFileFtp

        public boolean getFileFtp()
        Get the FileInputNode "Remote Transfer" property
        Returns:
        boolean; the value of the property "Remote Transfer"
      • getRemoteTransferType

        public FileInputNode.ENUM_FILEINPUT_REMOTETRANSFERTYPE getRemoteTransferType()
        Get the FileInputNode "Transfer protocol" property
        Returns:
        ENUM_FILEINPUT_REMOTETRANSFERTYPE; the value of the property "Transfer protocol"
      • setFileFtpServer

        public FileInputNode setFileFtpServer(java.lang.String value)
        Set the FileInputNode "Server and port" property
        Parameters:
        value - String ; the value to set the property "Server and port"
      • getFileFtpServer

        public java.lang.String getFileFtpServer()
        Get the FileInputNode "Server and port" property
        Returns:
        String; the value of the property "Server and port"
      • setFileFtpUser

        public FileInputNode setFileFtpUser(java.lang.String value)
        Set the FileInputNode "Security identity" property
        Parameters:
        value - String ; the value to set the property "Security identity"
      • getFileFtpUser

        public java.lang.String getFileFtpUser()
        Get the FileInputNode "Security identity" property
        Returns:
        String; the value of the property "Security identity"
      • setFileFtpDirectory

        public FileInputNode setFileFtpDirectory(java.lang.String value)
        Set the FileInputNode "Server directory" property
        Parameters:
        value - String ; the value to set the property "Server directory"
      • getFileFtpDirectory

        public java.lang.String getFileFtpDirectory()
        Get the FileInputNode "Server directory" property
        Returns:
        String; the value of the property "Server directory"
      • getFileFtpTransferMode

        public FileInputNode.ENUM_FILEINPUT_FILEFTPTRANSFERMODE getFileFtpTransferMode()
        Get the FileInputNode "Transfer mode" property
        Returns:
        ENUM_FILEINPUT_FILEFTPTRANSFERMODE; the value of the property "Transfer mode"
      • setFileFtpScanDelay

        public FileInputNode setFileFtpScanDelay(int value)
        Set the FileInputNode "Scan delay" property
        Parameters:
        value - int ; the value to set the property "Scan delay"
      • getFileFtpScanDelay

        public int getFileFtpScanDelay()
        Get the FileInputNode Scan delay property
        Returns:
        int; the value of the property "Scan delay"
      • getTransactionMode

        public FileInputNode.ENUM_FILEINPUT_TRANSACTIONMODE getTransactionMode()
        Get the FileInputNode "Transaction mode" property
        Returns:
        ENUM_FILEINPUT_TRANSACTIONMODE; the value of the property "Transaction mode"
      • setComponentLevel

        public FileInputNode setComponentLevel(FileInputNode.ENUM_FILEINPUT_COMPONENTLEVEL value)
        Set the FileInputNode "Additional instances pool" property
        Parameters:
        value - ENUM_FILEINPUT_COMPONENTLEVEL ; the value to set the property "Additional instances pool"
      • getComponentLevel

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

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

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