net.sf.fsp.fsplib

Class FSPOutputStream

java.lang.Object

java.io.OutputStream

net.sf.fsp.fsplib.FSPOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FSPOutputStream
extends OutputStream

Stream for writing file to FSP server. You can not have more than one file opened for write per FSPsession.

Since:

1.0rc7

Author:

Radim Kolar

See Also:

OutputStream

Constructor Summary

Constructors

Constructor and Description
FSPOutputStream(FSPsession session, String filename) Creates stream for writing file to FSP server.

Method Summary

Modifier and Type	Method and Description
void	close() Flushes buffer and installs file.
void	finalize() cancels pending upload and unlocks writer object.
void	flush() Flushes internal buffer to FSP server.
void	write(byte[] b, int off, int len) Writes byte array to FSP server
void	write(int b) Writes single byte to FSP server

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FSPOutputStream

public FSPOutputStream(FSPsession session,
                       String filename)

Creates stream for writing file to FSP server. Because FSP protocol always uploads to temporary file no checking if client can really create/overwrite desired file is performed until end of upload. Custom timestamp on uploaded file is not supported by this class. This constructor will block if there is already another active writing stream assigned to FSPsession.

Parameters:

session - FSPsession to target server

filename - filename

Since:

1.0rc7

See Also:

FSPutil.upload(FSPsession, String, java.io.InputStream, long), FSPutil.canUpload(FSPsession, String)

Method Detail

flush

public void flush()
           throws IOException

Flushes internal buffer to FSP server. File on FSP server is not created until stream is closed. This function always sent packet to server even if internal buffer is currently empty.

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

Since:

1.0rc7

write

public void write(int b)
           throws IOException

Writes single byte to FSP server

Specified by:

write in class OutputStream

Parameters:

b - byte to write

Throws:

IOException

Since:

1.0rc7

See Also:

OutputStream.write(int)

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Writes byte array to FSP server

Overrides:

write in class OutputStream

Parameters:

b - array containing data to write

off - data to write offset

len - lenght of data to write

Throws:

IOException

Since:

1.0rc7

See Also:

OutputStream.write(byte[], int, int)

close

public void close()
           throws IOException

Flushes buffer and installs file. Setting filestamp on target file is not supported by this function.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

Since:

1.0rc7

See Also:

FSPutil.upload(FSPsession, String, java.io.InputStream, long)

finalize

public void finalize()
              throws Exception

cancels pending upload and unlocks writer object. This function will fail if FSPsession was finalized sooner

Overrides:

finalize in class Object

Throws:

Exception

Since:

1.0rc8