org.jboss.remoting.marshal.compress
Class CompressingMarshaller

java.lang.Object
  org.jboss.remoting.marshal.serializable.SerializableMarshaller
      org.jboss.remoting.marshal.compress.CompressingMarshaller

All Implemented Interfaces:

java.io.Serializable, Marshaller, PreferredStreamMarshaller, SerialMarshaller, VersionedMarshaller

public class CompressingMarshaller
extends SerializableMarshaller

CompressingMarshaller and CompressingUnMarshaller are a general purpose compressing marshaller / decompressing unmarshaller pair based on Java's GZIP facilities.

CompressingMarshaller is subclassed from SerializableMarshaller, and by default it uses super.write() to marshall an object, which is then compressed. Optionally, it can wrap any other marshaller and use that instead of SerializableMarshaller to marshall an object before it is compressed. For example,

new CompressingMarshaller(new HTTPMarshaller())

will create a marshaller that compresses the output of an HTTPMarshaller.

Version:

$Revision: 2966 $

Copyright (c) 2005

Author:

Ron Sigal

See Also:

Serialized Form

Field Summary

static java.lang.String

DATATYPE

Constructor Summary

CompressingMarshaller()
Create a new CompressingMarshaller.

CompressingMarshaller(Marshaller marshaller)
Create a new CompressingMarshaller.

Method Summary

Marshaller	cloneMarshaller() Returns a CompressingMarshaller.
java.io.OutputStream	getMarshallingStream(java.io.OutputStream outputStream) An application that calls getMarshallingStream() should provide a basic OutputStream, e.g., SocketOutputStream, which can be wrapped to provide the facilities desired by the PreferredStreamMarshaller.
void	write(java.lang.Object dataObject, java.io.OutputStream output, int version) Writes compressed, marshalled form of dataObject to output.

Methods inherited from class org.jboss.remoting.marshal.serializable.SerializableMarshaller

getMarshallingStream, getSerializationType, setSerializationType, write

Methods inherited from class java.lang.Object

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

Field Detail

DATATYPE

public static final java.lang.String DATATYPE

See Also:

Constant Field Values

Constructor Detail

CompressingMarshaller

public CompressingMarshaller()

Create a new CompressingMarshaller.

CompressingMarshaller

public CompressingMarshaller(Marshaller marshaller)

Create a new CompressingMarshaller.

Parameters:

marshaller - A Marshaller which is used to turn objects into byte streams.

Method Detail

getMarshallingStream

public java.io.OutputStream getMarshallingStream(java.io.OutputStream outputStream)
                                          throws java.io.IOException

Description copied from interface: PreferredStreamMarshaller

An application that calls getMarshallingStream() should provide a basic OutputStream, e.g., SocketOutputStream, which can be wrapped to provide the facilities desired by the PreferredStreamMarshaller.

Specified by:

getMarshallingStream in interface PreferredStreamMarshaller

Overrides:

getMarshallingStream in class SerializableMarshaller

Parameters:

outputStream - a raw OutputStream

Returns:

the OutputStream to be used for marshalling

Throws:

java.io.IOException - if it unable to create OutputStream

write

public void write(java.lang.Object dataObject,
                  java.io.OutputStream output,
                  int version)
           throws java.io.IOException

Writes compressed, marshalled form of dataObject to output.

Specified by:

write in interface VersionedMarshaller

Overrides:

write in class SerializableMarshaller

Parameters:

dataObject - arbitrary object to be marshalled

output - OutputStream to which output is to be marshalled

version - wire format version

Throws:

java.io.IOException

cloneMarshaller

public Marshaller cloneMarshaller()
                           throws java.lang.CloneNotSupportedException

Returns a CompressingMarshaller.

Specified by:

cloneMarshaller in interface Marshaller

Overrides:

cloneMarshaller in class SerializableMarshaller

Returns:

a CompressingMarshaller.

Throws:

java.lang.CloneNotSupportedException - In practice no exceptions are thrown