All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.as400.access.IFSFileOutputStream
java.lang.Object
|
+----java.io.OutputStream
|
+----com.ibm.as400.access.IFSFileOutputStream
- public class IFSFileOutputStream
- extends OutputStream
- implements Serializable
The IFSFileOutputStream class 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, removeFileListener
-
changes_
-
-
fd_
-
-
SHARE_ALL
- Share option that allows read and write access by other users.
-
SHARE_NONE
- Share option that does not allow read or write access by other users.
-
SHARE_READERS
- Share option that allows only read access by other users.
-
SHARE_WRITERS
- Share option that allows only write access by other users.
-
vetos_
-
-
IFSFileOutputStream()
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, IFSFile, int, boolean)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, IFSFile, int, boolean, int)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, IFSJavaFile, int, boolean)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, IFSJavaFile, int, boolean, int)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, String)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, String, int)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, String, int, boolean)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(AS400, String, int, boolean, int)
- Constructs an IFSFileOutputStream object.
-
IFSFileOutputStream(IFSFileDescriptor)
- Creates a file output stream to write to file descriptor fd.
-
addFileListener(FileListener)
- Adds a file listener to receive file events from this IFSFileOutputStream.
-
addPropertyChangeListener(PropertyChangeListener)
- Adds a property change listener.
-
addVetoableChangeListener(VetoableChangeListener)
- Adds a vetoable change listener.
-
close()
- Closes this file output stream and releases any system resources associated
with this stream.
-
connectionDropped(ConnectionDroppedException)
- Disconnects from the byte stream server.
-
finalize()
- Ensures that the file output stream is closed when there are no more
references to it.
-
flush()
- Forces any buffered output bytes to be written.
-
getFD()
- Returns the file descriptor associated with this stream.
-
getPath()
- Returns the integrated file system path name of the object represented by
this IFSFileOutputStream object.
-
getShareOption()
- Returns the share option for this object.
-
getSystem()
- Returns the AS400 system object for this stream.
-
lock(int)
- Places a lock on the file at the current position for the specified number
of bytes.
-
open(int)
- Opens the specified file.
-
removeFileListener(FileListener)
- Removes a file listener so that it no longer receives file events from
this IFSFileOutputStream.
-
removePropertyChangeListener(PropertyChangeListener)
- Removes a property change listener.
-
removeVetoableChangeListener(VetoableChangeListener)
- Removes a vetoable change listener.
-
setAppend(boolean)
- Sets the append option.
-
setFD(IFSFileDescriptor)
- Sets the file descriptor.
-
setPath(String)
- Sets the integrated file system path name.
-
setShareOption(int)
- Sets the share option.
-
setSystem(AS400)
- Sets the system.
-
unlock(IFSKey)
- Undoes a lock on this file.
-
write(byte[])
- Writes data.length bytes of data from the byte array data
to this file output stream.
-
write(byte[], int, int)
- Writes length bytes of data from the byte array data, starting
at offset, to this file output stream.
-
write(int)
- Writes the specified byte to this file output stream.
SHARE_ALL
public static final int SHARE_ALL
- Share option that allows read and write access by other users.
SHARE_NONE
public static final int SHARE_NONE
- Share option that does not allow read or write access by other users.
SHARE_READERS
public static final int SHARE_READERS
- Share option that allows only read access by other users.
SHARE_WRITERS
public static final int SHARE_WRITERS
- Share option that allows only write access by other users.
changes_
protected transient PropertyChangeSupport changes_
vetos_
protected transient VetoableChangeSupport vetos_
fd_
protected IFSFileDescriptor fd_
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 AS/400 that contains the file.
- name - The file to be opened for writing.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
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 AS/400 that contains the file.
- name - The file to be opened for writing.
- ccsid - The target CCSID with which to write data.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
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 AS/400 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 output replaces the file contents.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
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 AS/400 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 output replaces the file contents.
- ccsid - The target CCSID with which to write data.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
IFSFileOutputStream
public IFSFileOutputStream(AS400 system,
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:
- system - The AS/400 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 output replaces the file contents.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
IFSFileOutputStream
public IFSFileOutputStream(AS400 system,
IFSFile file,
int shareOption,
boolean append,
int ccsid) throws AS400SecurityException, IOException
- Constructs an IFSFileOutputStream object.
It creates a file output stream to write to the file specified by file using the
ccsid specified by ccsid.
- Parameters:
- system - The AS/400 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 output replaces the file contents.
- ccsid - The target CCSID with which to write data.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
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(AS400 system,
IFSJavaFile 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:
- system - The AS/400 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 output replaces the file contents.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
IFSFileOutputStream
public IFSFileOutputStream(AS400 system,
IFSJavaFile file,
int shareOption,
boolean append,
int ccsid) throws AS400SecurityException, IOException
- Constructs an IFSFileOutputStream object.
It creates a file output stream to write to the file specified by file using the
ccsid specified by ccsid.
- Parameters:
- system - The AS/400 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 output replaces the file contents.
- ccsid - The target CCSID with which to write data.
- Throws: AS400SecurityException
- If a security or authority error occurs.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
addFileListener
public synchronized void addFileListener(FileListener listener)
- Adds a file listener to receive file events from this IFSFileOutputStream.
- Parameters:
- listener - The file listener.
addPropertyChangeListener
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)
- Adds a property change listener.
- Parameters:
- listener - The property change listener to add.
addVetoableChangeListener
public synchronized 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.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Overrides:
- close in class OutputStream
connectionDropped
protected void connectionDropped(ConnectionDroppedException e) throws ConnectionDroppedException
- Disconnects from the byte stream server.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
finalize
protected void finalize() throws IOException
- Ensures that the file output stream is closed when there are no more
references to it.
- Throws: IOException
- If an error occurs while communicating with the AS/400.
- Overrides:
- finalize in class Object
flush
public void flush() throws IOException
- Forces any buffered output bytes to be written.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- Overrides:
- flush in class OutputStream
getFD
public final IFSFileDescriptor getFD() throws IOException
- Returns the file descriptor associated with this stream.
- Returns:
- The file descriptor associated with this stream.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
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
- Places a lock on the file at the current position for the specified number
of bytes.
- Parameters:
- length - The number of bytes to lock.
- Returns:
- A key for undoing this lock.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- See Also:
- IFSKey, unlock
open
protected void open(int fileDataCCSID) throws IOException
- Opens the specified file.
removeFileListener
public synchronized 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 synchronized void removePropertyChangeListener(PropertyChangeListener listener)
- Removes a property change listener.
- Parameters:
- listener - The property change listener to remove.
removeVetoableChangeListener
public synchronized 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 any existing file data.
- Throws: PropertyVetoException
- If the change is vetoed.
setFD
public void setFD(IFSFileDescriptor fd) throws PropertyVetoException
- Sets the file descriptor.
- Parameters:
- fd - The file descriptor.
- Throws: PropertyVetoException
- If the change is vetoed.
setPath
public void setPath(String path) throws PropertyVetoException
- Sets the integrated file system path name.
- Parameters:
- path - The absolute integrated file system path name.
- 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.
- Parameters:
- system - The AS/400 system object.
- Throws: PropertyVetoException
- If the change is vetoed.
unlock
public void unlock(IFSKey key) throws IOException
- Undoes a lock on this file.
- Parameters:
- key - The key for the lock.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- See Also:
- IFSKey, lock
write
public void write(int b) throws IOException
- Writes the specified byte to this file output stream.
- Parameters:
- b - The byte to be written.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- Overrides:
- write in class OutputStream
write
public void write(byte data[]) throws IOException
- Writes data.length bytes of data from the byte array data
to this file output stream.
- Parameters:
- data - The data to be written.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- Overrides:
- write in class OutputStream
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.
- Parameters:
- data - The data to be written.
- offset - The start offset in the data.
- length - The number of bytes to write.
- Throws: ConnectionDroppedException
- If the connection is dropped unexpectedly.
- Throws: InterruptedIOException
- If this thread is interrupted.
- Throws: ExtendedIOException
- If an error occurs while communicating with the AS/400.
- Throws: ServerStartupException
- If the AS/400 server cannot be started.
- Throws: UnknownHostException
- If the AS/400 system cannot be located.
- Overrides:
- write in class OutputStream
All Packages Class Hierarchy This Package Previous Next Index