com.perforce.p4java.impl.mapbased.rpc.sys

Class RpcOutputStream

java.lang.Object

java.io.OutputStream

java.io.FileOutputStream

com.perforce.p4java.impl.mapbased.rpc.sys.RpcOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class RpcOutputStream
extends FileOutputStream

Provides a Perforce-specific extension to the basic Java OuputStream to allow us to intercept methods and implement our own extensions. The two main aims here are for the GKUNZIP file type to stream unzip on the fly, and to do line end processing for text files where needed; everything else is just currently handled in the superclass without real intervention.

Note that for the unzipping we use a contained file output stream rather than ourself, mostly to avoid recursion...

Some of the raw GZUNZIP methods and definitions are copied pretty much as-is from the original gkzip stuff.

The 10.2 sync / transfer integrity checks are basically implemented here, with help from the RpcInflaterOutputStream class. The way this is done is the MD5 hashing has to be done against the incoming 'raw' bytes (i.e. the normalized server-side form of the file) unless the incoming file type is compressed binary, in which case we have to hash the uncompressed version. The non-binary hashing is done here; the compressed stuff is done in RpcInflaterOutputStream.

Constructor Summary

Constructors

Constructor and Description
RpcOutputStream(RpcPerforceFile file)
RpcOutputStream(RpcPerforceFile file, Charset charset, boolean isUnicodeServer, boolean useLocalDigester)
RpcOutputStream(RpcPerforceFile file, Charset charset, boolean isUnicodeServer, boolean useLocalDigester, int filesys_utf8bom)
RpcOutputStream(RpcPerforceFile file, RpcConnection rpcConnection, boolean useLocalDigester)

Method Summary

Modifier and Type	Method and Description
void	close()
RpcPerforceFile	getFile()
MD5Digester	getLocalDigester()
String	getServerDigest()
void	setLocalDigester(MD5Digester localDigester)
void	setServerDigest(String serverDigest)
void	write(byte[] b)
void	write(byte[] sourceBytes, int off, int len)
void	write(int b)
long	write(Map<String,Object> map) Specialized write method to write a map containing a byte array with the key RpcFunctionMapKey.DATA (all other fields are ignored).
long	writeConverted(byte[] sourceBytes) Write an array of bytes with being aware of encodings, line ending conversions, and compression.

Methods inherited from class java.io.FileOutputStream

finalize, getChannel, getFD

Methods inherited from class java.io.OutputStream

flush

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcOutputStream

public RpcOutputStream(RpcPerforceFile file)
                throws IOException

Throws:

IOException

RpcOutputStream

public RpcOutputStream(RpcPerforceFile file,
                       RpcConnection rpcConnection,
                       boolean useLocalDigester)
                throws IOException

Throws:

IOException

RpcOutputStream

public RpcOutputStream(RpcPerforceFile file,
                       Charset charset,
                       boolean isUnicodeServer,
                       boolean useLocalDigester)
                throws IOException

Throws:

IOException

RpcOutputStream

public RpcOutputStream(RpcPerforceFile file,
                       Charset charset,
                       boolean isUnicodeServer,
                       boolean useLocalDigester,
                       int filesys_utf8bom)
                throws IOException

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FileOutputStream

Throws:

IOException

write

public long write(Map<String,Object> map)
           throws IOException,
                  FileDecoderException,
                  FileEncoderException

Specialized write method to write a map containing a byte array with the key RpcFunctionMapKey.DATA (all other fields are ignored). This map is assumed to have been constructed as part of the writeFile() method or something similar.

Throws:

FileEncoderException

FileDecoderException

IOException

write

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

Overrides:

write in class FileOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

writeConverted

public long writeConverted(byte[] sourceBytes)
                    throws IOException,
                           FileDecoderException,
                           FileEncoderException

Write an array of bytes with being aware of encodings, line ending conversions, and compression. Any 10.2+ sync integrity checks are done either here or in the unzip's stream, but (definitely) not in both places.

Parameters:

sourceBytes -

Throws:

IOException

FileEncoderException

FileDecoderException

write

public void write(int b)
           throws IOException

Overrides:

write in class FileOutputStream

Throws:

IOException

getFile

public RpcPerforceFile getFile()

getServerDigest

public String getServerDigest()

setServerDigest

public void setServerDigest(String serverDigest)

getLocalDigester

public MD5Digester getLocalDigester()

setLocalDigester

public void setLocalDigester(MD5Digester localDigester)