com.ibm.broker.config.appdev.nodes

Class FileOutputNode

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


    public class FileOutputNode
    extends Node

    FileOutputNode instance

    FileOutput node outputs data to 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

      • FileOutputNode

        public FileOutputNode()
    • 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
      • setOutputDirectory

        public FileOutputNode setOutputDirectory(java.lang.String value)
        Set the FileOutputNode "Directory" property
        Parameters:
        value - String ; the value to set the property "Directory"
      • getOutputDirectory

        public java.lang.String getOutputDirectory()
        Get the FileOutputNode "Directory" property
        Returns:
        String; the value of the property "Directory"
      • setOutputFilename

        public FileOutputNode setOutputFilename(java.lang.String value)
        Set the FileOutputNode "File name or pattern" property
        Parameters:
        value - String ; the value to set the property "File name or pattern"
      • getOutputFilename

        public java.lang.String getOutputFilename()
        Get the FileOutputNode "File name or pattern" property
        Returns:
        String; the value of the property "File name or pattern"
      • getWriteMode

        public FileOutputNode.ENUM_FILEOUTPUT_WRITEMODE getWriteMode()
        Get the FileOutputNode "Mode for writing to file" property
        Returns:
        ENUM_FILEOUTPUT_WRITEMODE; the value of the property "Mode for writing to file"
      • getOutputMode

        public FileOutputNode.ENUM_FILEOUTPUT_OUTPUTMODE getOutputMode()
        Get the FileOutputNode "Action if file exists" property
        Returns:
        ENUM_FILEOUTPUT_OUTPUTMODE; the value of the property "Action if file exists"
      • setReplaceDuplicateArchives

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

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

        public FileOutputNode setFailedFileAction(FileOutputNode.ENUM_FILEOUTPUT_FAILEDFILEACTION value)
        Set the FileOutputNode "Action on final file transfer failure" property
        Parameters:
        value - ENUM_FILEOUTPUT_FAILEDFILEACTION ; the value to set the property "Action on final file transfer failure"
      • getFailedFileAction

        public FileOutputNode.ENUM_FILEOUTPUT_FAILEDFILEACTION getFailedFileAction()
        Get the FileOutputNode "Action on final file transfer failure" property
        Returns:
        ENUM_FILEOUTPUT_FAILEDFILEACTION; the value of the property "Action on final file transfer failure"
      • setDataLocation

        public FileOutputNode setDataLocation(java.lang.String value)
        Set the FileOutputNode "Data location" property
        Parameters:
        value - String ; the value to set the property "Data location"
      • getDataLocation

        public java.lang.String getDataLocation()
        Get the FileOutputNode "Data location" property
        Returns:
        String; the value of the property "Data location"
      • setRequestDirectoryLocation

        public FileOutputNode setRequestDirectoryLocation(java.lang.String value)
        Set the FileOutputNode "Request directory property location" property
        Parameters:
        value - String ; the value to set the property "Request directory property location"
      • getRequestDirectoryLocation

        public java.lang.String getRequestDirectoryLocation()
        Get the FileOutputNode "Request directory property location" property
        Returns:
        String; the value of the property "Request directory property location"
      • setRequestNameLocation

        public FileOutputNode setRequestNameLocation(java.lang.String value)
        Set the FileOutputNode "Request file name property location" property
        Parameters:
        value - String ; the value to set the property "Request file name property location"
      • getRequestNameLocation

        public java.lang.String getRequestNameLocation()
        Get the FileOutputNode "Request file name property location" property
        Returns:
        String; the value of the property "Request file name property location"
      • getRecordDefinition

        public FileOutputNode.ENUM_FILEOUTPUT_RECORDDEFINITION getRecordDefinition()
        Get the FileOutputNode "Record definition" property
        Returns:
        ENUM_FILEOUTPUT_RECORDDEFINITION; the value of the property "Record definition"
      • setRecordLength

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

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

        public FileOutputNode setRecordPadding(java.lang.String value)
        Set the FileOutputNode "Padding byte (hexadecimal)" property
        Parameters:
        value - String ; the value to set the property "Padding byte (hexadecimal)"
      • getRecordPadding

        public java.lang.String getRecordPadding()
        Get the FileOutputNode "Padding byte (hexadecimal)" property
        Returns:
        String; the value of the property "Padding byte (hexadecimal)"
      • setCustomDelimiter

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

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

        public FileOutputNode.ENUM_FILEOUTPUT_DELIMITERTYPE getDelimiterType()
        Get the FileOutputNode "Delimiter type" property
        Returns:
        ENUM_FILEOUTPUT_DELIMITERTYPE; the value of the property "Delimiter type"
      • setFileFtp

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

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

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

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

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

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

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

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

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

        public FileOutputNode.ENUM_FILEOUTPUT_FILEFTPREMOTEOUTPUTMODE getFileFtpRemoteOutputMode()
        Get the FileOutputNode "Action if remote file exists" property
        Returns:
        ENUM_FILEOUTPUT_FILEFTPREMOTEOUTPUTMODE; the value of the property "Action if remote file exists"
      • setFileFtpRetainAfterPut

        public FileOutputNode setFileFtpRetainAfterPut(boolean value)
        Set the FileOutputNode "Retain local file after transfer" property
        Parameters:
        value - boolean ; the value to set the property "Retain local file after transfer"
      • getFileFtpRetainAfterPut

        public boolean getFileFtpRetainAfterPut()
        Get the FileOutputNode "Retain local file after transfer" property
        Returns:
        boolean; the value of the property "Retain local file after transfer"
      • 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