com.ibm.as400.access

Class IFSFileOutputStream

  • All Implemented Interfaces:
    Closeable, Flushable, Serializable
    Direct Known Subclasses:
    IFSTextFileOutputStream


    public class IFSFileOutputStream
    extends OutputStream
    implements Serializable
    Represents an integrated file system file output stream. An integrated file system file output stream is an output stream for writing data to integrated file system objects.
    IFSFileOutputStream objects are capable of generating file events that call the following FileListener methods: fileClosed, fileModified, and fileOpended.
    The following example illustrates the use of IFSFileOutputStream:
     // Work with /Dir/File on the system eniac.
     AS400 as400 = new AS400("eniac");
     IFSFileOutputStream file = new IFSFileOutputStream(as400, "/Dir/File");
    // Lock the first 8 bytes of the file. IFSKey key = file.lock(8);
    // Write 8 bytes to the file. byte[] data = { 0, 1, 2, 3, 4, 5, 6, 7 }; file.write(data, 0, 8);
    // Unlock the first 8 bytes. file.unlock(key);
    // Close the file. file.close();
    See Also:
    FileEvent, addFileListener(com.ibm.as400.access.FileListener), removeFileListener(com.ibm.as400.access.FileListener), Serialized Form
    • Constructor Detail

      • IFSFileOutputStream

        public IFSFileOutputStream()
        Constructs an IFSFileOutputStream object. It is a default file output stream.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           String name)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file with the specified name. Other readers and writers are allowed to access the file. The file is replaced if it exists; otherwise, the file is created.
        Parameters:
        system - The system that contains the file.
        name - The file to be opened for writing.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           String name,
                           int ccsid)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file with the specified name and ccsid. Other readers and writers are allowed to access the file. The file is replaced if it exists; otherwise, the file is created.
        Parameters:
        system - The system that contains the file.
        name - The file to be opened for writing.
        ccsid - The CCSID with which to tag the data in the file.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           String name,
                           int shareOption,
                           boolean append)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file with the specified name.
        Parameters:
        system - The system that contains the file.
        name - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           String name,
                           int shareOption,
                           boolean append,
                           int ccsid)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file with the specified name and ccsid.
        Parameters:
        system - The system that contains the file.
        name - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        ccsid - The CCSID with which to tag the data in the file.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(IFSFile file)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file specified by file. Other readers and writers are allowed to access the file. The file is replaced if it exists; otherwise, the file is created.
        Parameters:
        file - The file to be opened for writing.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           IFSFile file,
                           int shareOption,
                           boolean append)
                            throws AS400SecurityException,
                                   IOException
        Deprecated. Use IFSFileOutputStream(IFSFile, int, boolean) instead.
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file specified by file.
        Parameters:
        system - The system that contains the file.
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(IFSFile file,
                           int shareOption,
                           boolean append)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. It creates a file output stream to write to the file specified by file.
        Parameters:
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           IFSFile file,
                           int shareOption,
                           boolean append,
                           int ccsid)
                            throws AS400SecurityException,
                                   IOException
        Deprecated. Use IFSFileOutputStream(IFSFile, int, boolean, int) instead.
        Constructs an IFSFileOutputStream object. Creates a file output stream to write to the file specified by file, tagging the data with the CCSID specified by ccsid.
        Parameters:
        system - The system that contains the file.
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        ccsid - The CCSID with which to tag the data in the file.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(IFSFile file,
                           int shareOption,
                           boolean append,
                           int ccsid)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. Creates a file output stream to write to the file specified by file, tagging the data with the CCSID specified by ccsid.
        Parameters:
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        ccsid - The CCSID with which to tag the data in the file.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(IFSFileDescriptor fd)
        Creates a file output stream to write to file descriptor fd.
        Parameters:
        fd - The file descriptor to be opened for writing.
      • IFSFileOutputStream

        public IFSFileOutputStream(IFSJavaFile file)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. Creates a file output stream to write to the file specified by file. Other readers and writers are allowed to access the file. The file is replaced if it exists; otherwise, the file is created.
        Parameters:
        file - The file to be opened for writing.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           IFSJavaFile file,
                           int shareOption,
                           boolean append)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. Creates a file output stream to write to the file specified by file.
        Parameters:
        system - The system that contains the file.
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.
      • IFSFileOutputStream

        public IFSFileOutputStream(AS400 system,
                           IFSJavaFile file,
                           int shareOption,
                           boolean append,
                           int ccsid)
                            throws AS400SecurityException,
                                   IOException
        Constructs an IFSFileOutputStream object. Creates a file output stream to write to the file specified by file, tagging the data with the CCSID specified by ccsid.
        Parameters:
        system - The system that contains the file.
        file - The file to be opened for writing.
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        append - Controls the behavior of the file. If true, output is appended to the file; otherwise, the current contents of the file are erased, and output replaces the file contents.
        ccsid - The CCSID with which to tag the data in the file.
        Throws:
        AS400SecurityException - If a security or authority error occurs.
        IOException - If an error occurs while communicating with the system.

    • Method Detail

      • addFileListener

        public void addFileListener(FileListener listener)
        Adds a file listener to receive file events from this IFSFileOutputStream.
        Parameters:
        listener - The file listener.
      • addPropertyChangeListener

        public void addPropertyChangeListener(PropertyChangeListener listener)
        Adds a property change listener.
        Parameters:
        listener - The property change listener to add.
      • addVetoableChangeListener

        public void addVetoableChangeListener(VetoableChangeListener listener)
        Adds a vetoable change listener.
        Parameters:
        listener - The vetoable change listener to add.
      • close

        public void close()
                   throws IOException
        Closes this file output stream and releases any system resources associated with this stream.
        Specified by:
        close in interface Closeable
        Overrides:
        close in class OutputStream
        Throws:
        IOException - If an error occurs while communicating with the system.
      • finalize

        protected void finalize()
                         throws IOException
        Ensures that the file output stream is closed when there are no more references to it.
        Overrides:
        finalize in class Object
        Throws:
        IOException - If an error occurs while communicating with the system.
      • getFD

        public final IFSFileDescriptor getFD()
                                      throws IOException
        Returns the file descriptor associated with this stream.
        Returns:
        The file descriptor associated with this stream.
        Throws:
        IOException - If an error occurs while communicating with the system.
      • getPath

        public String getPath()
        Returns the integrated file system path name of the object represented by this IFSFileOutputStream object.
        Returns:
        The absolute path name of the object.
      • getShareOption

        public int getShareOption()
        Returns the share option for this object.
        Returns:
        The share option.
      • getSystem

        public AS400 getSystem()
        Returns the AS400 system object for this stream.
        Returns:
        The AS400 system object.
      • lock

        public IFSKey lock(int length)
                    throws IOException
        Deprecated. Replaced by lock(long)
        Places a lock on the file at the current position for the specified number of bytes. Note: This method is not supported for files under QSYS.
        Parameters:
        length - The number of bytes to lock.
        Returns:
        A key for undoing this lock.
        Throws:
        ExtendedIOException - If the specified bytes are already locked by another process.
        IOException - If an error occurs while communicating with the system.
        See Also:
        unlock(com.ibm.as400.access.IFSKey)
      • lock

        public IFSKey lock(long length)
                    throws IOException
        Places a lock on the file at the current position for the specified number of bytes. Note: This method is not supported for files under QSYS.
        Parameters:
        length - The number of bytes to lock.
        Returns:
        A key for undoing this lock.
        Throws:
        IOException - If an error occurs while communicating with the system.
        See Also:
        unlock(com.ibm.as400.access.IFSKey)
      • open

        protected void open(int fileDataCCSID)
                     throws IOException
        Opens the specified file. If the file is already open, does nothing.
        Parameters:
        fileDataCCSID - The CCSID with which to tag the data in the file.
        Throws:
        IOException - If an error occurs while communicating with the system.
      • removeFileListener

        public void removeFileListener(FileListener listener)
        Removes a file listener so that it no longer receives file events from this IFSFileOutputStream.
        Parameters:
        listener - The file listener.
      • removePropertyChangeListener

        public void removePropertyChangeListener(PropertyChangeListener listener)
        Removes a property change listener.
        Parameters:
        listener - The property change listener to remove.
      • removeVetoableChangeListener

        public void removeVetoableChangeListener(VetoableChangeListener listener)
        Removes a vetoable change listener.
        Parameters:
        listener - The vetoable change listener to remove.
      • setAppend

        public void setAppend(boolean append)
                       throws PropertyVetoException
        Sets the append option.
        Parameters:
        append - If true, data is appended to an existing file; otherwise, output replaces the file contents.
        Throws:
        PropertyVetoException - If the change is vetoed.
      • setShareOption

        public void setShareOption(int shareOption)
                            throws PropertyVetoException
        Sets the share option.
        Parameters:
        shareOption - Indicates how users can access the file.
        • SHARE_ALL Share access with readers and writers
        • SHARE_NONE Share access with none
        • SHARE_READERS Share access with readers
        • SHARE_WRITERS Share access with writers
        Throws:
        PropertyVetoException - If the change is vetoed.
      • setSystem

        public void setSystem(AS400 system)
                       throws PropertyVetoException
        Sets the system. The system cannot be changed once a connection is made to the system.
        Parameters:
        system - The system object.
        Throws:
        PropertyVetoException - If the change is vetoed.
      • unlock

        public void unlock(IFSKey key)
                    throws IOException
        Undoes a lock on this file. Note: This method is not supported for files under QSYS.
        Parameters:
        key - The key for the lock.
        Throws:
        IOException - If an error occurs while communicating with the system.
        See Also:
        IFSKey, lock(long)
      • write

        public void write(int b)
                   throws IOException
        Writes the specified byte to this file output stream.
        Specified by:
        write in class OutputStream
        Parameters:
        b - The byte to be written.
        Throws:
        IOException - If an error occurs while communicating with the system.
      • write

        public void write(byte[] data)
                   throws IOException
        Writes data.length bytes of data from the byte array data to this file output stream.
        Overrides:
        write in class OutputStream
        Parameters:
        data - The data to be written.
        Throws:
        IOException - If an error occurs while communicating with the system.
      • write

        public void write(byte[] data,
                 int dataOffset,
                 int length)
                   throws IOException
        Writes length bytes of data from the byte array data, starting at offset, to this file output stream.
        Overrides:
        write in class OutputStream
        Parameters:
        data - The data to be written.
        dataOffset - The start offset in the data.
        length - The number of bytes to write.
        Throws:
        IOException - If an error occurs while communicating with the system.