org.apache.river.api.io

Class AtomicMarshalOutputStream

java.lang.Object

java.io.OutputStream

java.io.ObjectOutputStream

net.jini.io.MarshalOutputStream

org.apache.river.api.io.AtomicMarshalOutputStream

All Implemented Interfaces:

Closeable, DataOutput, Flushable, ObjectOutput, ObjectStreamConstants, AutoCloseable, ObjectStreamContext

public class AtomicMarshalOutputStream
extends MarshalOutputStream

This AtomicMarshalOutputStream, replaces a number of Java Object's in the stream with Serializer's that ordinarily would not be deserializable by AtomicMarshalInputStream or would not be safe to be deserialized, this includes, but is not limited to Java Collections classes, Throwable subclasses and object versions of primitive values.

Author:

peter

Nested Class Summary

Nested classes/interfaces inherited from class java.io.ObjectOutputStream

ObjectOutputStream.PutField

Field Summary

Fields inherited from interface java.io.ObjectStreamConstants

baseWireHandle, PROTOCOL_VERSION_1, PROTOCOL_VERSION_2, SC_BLOCK_DATA, SC_ENUM, SC_EXTERNALIZABLE, SC_SERIALIZABLE, SC_WRITE_METHOD, STREAM_MAGIC, STREAM_VERSION, SUBCLASS_IMPLEMENTATION_PERMISSION, SUBSTITUTION_PERMISSION, TC_ARRAY, TC_BASE, TC_BLOCKDATA, TC_BLOCKDATALONG, TC_CLASS, TC_CLASSDESC, TC_ENDBLOCKDATA, TC_ENUM, TC_EXCEPTION, TC_LONGSTRING, TC_MAX, TC_NULL, TC_OBJECT, TC_PROXYCLASSDESC, TC_REFERENCE, TC_RESET, TC_STRING

Constructor Summary

Constructors

Constructor and Description
AtomicMarshalOutputStream(OutputStream out, ClassLoader defaultLoader, Collection context, boolean writeCodebaseAnnotations)
AtomicMarshalOutputStream(OutputStream out, Collection context)

Method Summary

Modifier and Type	Method and Description
void	close()
void	defaultWriteObject()
protected void	drain()
protected boolean	enableReplaceObject(boolean enable)
void	flush()
ObjectOutputStream.PutField	putFields()
protected Object	replaceObject(Object obj) This implementation replaces the following types in the stream:
void	reset() Reset will disregard the state of any objects already written to the stream.
void	useProtocolVersion(int version)
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)
protected void	writeAnnotation(String annotation) Writes a class annotation string value (possibly null) to be read by a corresponding MarshalInputStream implementation.
void	writeBoolean(boolean v)
void	writeByte(int v)
void	writeBytes(String s)
void	writeChar(int v)
void	writeChars(String s)
protected void	writeClassDescriptor(ObjectStreamClass desc)
void	writeDouble(double v)
void	writeFields()
void	writeFloat(float v)
void	writeInt(int v)
void	writeLong(long v)
void	writeObjectOverride(Object obj)
void	writeShort(int v)
void	writeUnshared(Object obj)
void	writeUTF(String s)

Methods inherited from class net.jini.io.MarshalOutputStream

annotateClass, annotateProxyClass, getObjectStreamContext

Methods inherited from class java.io.ObjectOutputStream

writeObject, writeStreamHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomicMarshalOutputStream

public AtomicMarshalOutputStream(OutputStream out,
                                 Collection context)
                          throws IOException

Throws:

IOException

AtomicMarshalOutputStream

public AtomicMarshalOutputStream(OutputStream out,
                                 ClassLoader defaultLoader,
                                 Collection context,
                                 boolean writeCodebaseAnnotations)
                          throws IOException

Parameters:

out -

defaultLoader -

context -

writeCodebaseAnnotations - if false stream format is generally compatible with ObjectOutputStream and annotations aren't written to stream, if true, it's generally compatible with MarshalOutputStream and annotations are written to stream.

Throws:

IOException

Method Detail

writeObjectOverride

public final void writeObjectOverride(Object obj)
                               throws IOException

Overrides:

writeObjectOverride in class ObjectOutputStream

Throws:

IOException

writeAnnotation

protected void writeAnnotation(String annotation)
                        throws IOException

Description copied from class: MarshalOutputStream

Writes a class annotation string value (possibly null) to be read by a corresponding MarshalInputStream implementation.

MarshalOutputStream implements this method to just write the annotation value to this stream using writeObject.

A subclass can override this method to write the annotation to a different location.

Overrides:

writeAnnotation in class MarshalOutputStream

Parameters:

annotation - the class annotation string value (possibly null) to write

Throws:

IOException - if I/O exception occurs writing the annotation

writeUnshared

public void writeUnshared(Object obj)
                   throws IOException

Overrides:

writeUnshared in class ObjectOutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

write

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

Specified by:

write in interface DataOutput

Specified by:

write in interface ObjectOutput

Overrides:

write in class ObjectOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Specified by:

flush in interface ObjectOutput

Overrides:

flush in class ObjectOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectOutput

Specified by:

close in interface AutoCloseable

Overrides:

close in class ObjectOutputStream

Throws:

IOException

writeBoolean

public void writeBoolean(boolean v)
                  throws IOException

Specified by:

writeBoolean in interface DataOutput

Overrides:

writeBoolean in class ObjectOutputStream

Throws:

IOException

writeByte

public void writeByte(int v)
               throws IOException

Specified by:

writeByte in interface DataOutput

Overrides:

writeByte in class ObjectOutputStream

Throws:

IOException

writeShort

public void writeShort(int v)
                throws IOException

Specified by:

writeShort in interface DataOutput

Overrides:

writeShort in class ObjectOutputStream

Throws:

IOException

writeChar

public void writeChar(int v)
               throws IOException

Specified by:

writeChar in interface DataOutput

Overrides:

writeChar in class ObjectOutputStream

Throws:

IOException

writeInt

public void writeInt(int v)
              throws IOException

Specified by:

writeInt in interface DataOutput

Overrides:

writeInt in class ObjectOutputStream

Throws:

IOException

writeLong

public void writeLong(long v)
               throws IOException

Specified by:

writeLong in interface DataOutput

Overrides:

writeLong in class ObjectOutputStream

Throws:

IOException

writeFloat

public void writeFloat(float v)
                throws IOException

Specified by:

writeFloat in interface DataOutput

Overrides:

writeFloat in class ObjectOutputStream

Throws:

IOException

writeDouble

public void writeDouble(double v)
                 throws IOException

Specified by:

writeDouble in interface DataOutput

Overrides:

writeDouble in class ObjectOutputStream

Throws:

IOException

writeBytes

public void writeBytes(String s)
                throws IOException

Specified by:

writeBytes in interface DataOutput

Overrides:

writeBytes in class ObjectOutputStream

Throws:

IOException

writeChars

public void writeChars(String s)
                throws IOException

Specified by:

writeChars in interface DataOutput

Overrides:

writeChars in class ObjectOutputStream

Throws:

IOException

writeUTF

public void writeUTF(String s)
              throws IOException

Specified by:

writeUTF in interface DataOutput

Overrides:

writeUTF in class ObjectOutputStream

Throws:

IOException

drain

protected void drain()
              throws IOException

Overrides:

drain in class ObjectOutputStream

Throws:

IOException

enableReplaceObject

protected boolean enableReplaceObject(boolean enable)
                               throws SecurityException

Overrides:

enableReplaceObject in class ObjectOutputStream

Throws:

SecurityException

replaceObject

protected Object replaceObject(Object obj)
                        throws IOException

This implementation replaces the following types in the stream:

Overrides:

replaceObject in class ObjectOutputStream

Parameters:

obj -

Returns:

Throws:

IOException

writeClassDescriptor

protected void writeClassDescriptor(ObjectStreamClass desc)
                             throws IOException

Overrides:

writeClassDescriptor in class ObjectOutputStream

Throws:

IOException

useProtocolVersion

public void useProtocolVersion(int version)
                        throws IOException

Overrides:

useProtocolVersion in class ObjectOutputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Reset will disregard the state of any objects already written to the stream. The state is reset to be the same as a new ObjectOutputStream. The current point in the stream is marked as reset so the corresponding ObjectInputStream will be reset at the same point. Objects previously written to the stream will not be referred to as already being in the stream. They will be written to the stream again.

Overrides:

reset in class ObjectOutputStream

Throws:

IOException - if reset() is invoked while serializing an object.

defaultWriteObject

public void defaultWriteObject()
                        throws IOException

Overrides:

defaultWriteObject in class ObjectOutputStream

Throws:

IOException

putFields

public ObjectOutputStream.PutField putFields()
                                      throws IOException

Overrides:

putFields in class ObjectOutputStream

Throws:

IOException

writeFields

public void writeFields()
                 throws IOException

Overrides:

writeFields in class ObjectOutputStream

Throws:

IOException