Package com.gigaspaces.internal.io

Class MarshalInputStream

java.lang.Object

java.io.InputStream

java.io.ObjectInputStream

com.gigaspaces.internal.io.AnnotatedObjectInputStream

com.gigaspaces.internal.io.MarshalInputStream

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, ObjectStreamConstants, AutoCloseable

public class MarshalInputStream
extends AnnotatedObjectInputStream

An extension of AnnotatedObjectInputStream that provides local storage of already resolved class descriptors, to optimize the marshaling.

Since:

5.0

Author:

Igor Goldenberg, anna

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarshalInputStream.Context

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

ObjectInputStream.GetField

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, SERIAL_FILTER_PERMISSION, 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	Description
MarshalInputStream(InputStream in)
MarshalInputStream(InputStream in, MarshalInputStream.Context context)

Method Summary

Modifier and Type	Method	Description
void	closeContext()
static MarshalInputStream.Context	createContext()
protected String	readAnnotation(ObjectStreamClass desc)	Reads and returns a class annotation string value (possibly null) that was written by a corresponding AnnotatedObjectOutputStream implementation.
protected ObjectStreamClass	readClassDescriptor()	Overrides the super method and tries to get the class descriptor from a local map.
Object	readRepetitiveObject()	Reads a repetitive object which was written by MarshalOutputStream.writeRepetitiveObject(java.lang.Object).
Object	readSmartExternalizable()
protected void	readStreamHeader()
void	resetContext()
protected Class<?>	resolveClass(ObjectStreamClass classDesc)	Resolves the appropriate Class object for the stream class descriptor classDesc.
protected Class<?>	resolveProxyClass(String[] interfaceNames)	Resolves the appropriate Class object for the proxy class described by the interface names interfaceNames.

Methods inherited from class com.gigaspaces.internal.io.AnnotatedObjectInputStream

resolveClass

Methods inherited from class java.io.ObjectInputStream

available, close, defaultReadObject, enableResolveObject, getObjectInputFilter, read, read, readBoolean, readByte, readChar, readDouble, readFields, readFloat, readFully, readFully, readInt, readLine, readLong, readObject, readObjectOverride, readShort, readUnshared, readUnsignedByte, readUnsignedShort, readUTF, registerValidation, resolveObject, setObjectInputFilter, skipBytes

Methods inherited from class java.io.InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.ObjectInput

read, skip

Constructor Details

MarshalInputStream

public MarshalInputStream(InputStream in)
                   throws IOException

Parameters:

in - input stream to wrap.

Throws:

IOException

MarshalInputStream

public MarshalInputStream(InputStream in,
 MarshalInputStream.Context context)
                   throws IOException

Throws:

IOException

Method Details

createContext

public static MarshalInputStream.Context createContext()

readRepetitiveObject

public Object readRepetitiveObject()
                            throws IOException,
ClassNotFoundException

Reads a repetitive object which was written by MarshalOutputStream.writeRepetitiveObject(java.lang.Object).

Throws:

IOException

ClassNotFoundException

readSmartExternalizable

public Object readSmartExternalizable()
                               throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

resolveClass

protected Class<?> resolveClass(ObjectStreamClass classDesc)
                         throws IOException,
ClassNotFoundException

Resolves the appropriate Class object for the stream class descriptor classDesc.

MarshalInputStream implements this method as follows:

First tries to check if this class descriptor was already resolved if it does return the class.

Else invokes the super class implementation.

Overrides:

resolveClass in class AnnotatedObjectInputStream

Parameters:

classDesc - the stream class descriptor to resolve

Returns:

the resolved class

Throws:

IOException - if readAnnotation throws an IOException, or if ClassLoading.loadClass throws a MalformedURLException

ClassNotFoundException - if readAnnotation or ClassLoading.loadClass throws a ClassNotFoundException

NullPointerException - if classDesc is null

readAnnotation

protected String readAnnotation(ObjectStreamClass desc)
                         throws IOException,
ClassNotFoundException

Description copied from class: AnnotatedObjectInputStream

Reads and returns a class annotation string value (possibly null) that was written by a corresponding AnnotatedObjectOutputStream implementation.

AnnotatedObjectInputStream implements this method to just read the annotation value from this stream using readUnshared, and if readUnshared returns a non-null value that is not a String, an InvalidObjectException is thrown.

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

Overrides:

readAnnotation in class AnnotatedObjectInputStream

Returns:

the class annotation string value read (possibly null)

Throws:

IOException - if an I/O exception occurs reading the annotation

ClassNotFoundException - if a ClassNotFoundException occurs reading the annotation

resolveProxyClass

protected Class<?> resolveProxyClass(String[] interfaceNames)
                              throws IOException,
ClassNotFoundException

Resolves the appropriate Class object for the proxy class described by the interface names interfaceNames.

MarshalInputStream implements this method as follows:

First tries to check if this class descriptor was already resolved if it does return the class.

Else invokes the super class implementation

Overrides:

resolveProxyClass in class ObjectInputStream

Parameters:

interfaceNames - the list of interface names that were deserialized in the proxy class descriptor

Returns:

the resolved dynamic proxy class

Throws:

IOException - if readAnnotation throws an IOException, or if ClassLoading.loadProxyClass throws a MalformedURLException

ClassNotFoundException - if readAnnotation or ClassLoading.loadProxyClass throws a ClassNotFoundException

NullPointerException - if interfaceNames is null or if any element of interfaceNames is null

readClassDescriptor

protected ObjectStreamClass readClassDescriptor()
                                         throws IOException,
ClassNotFoundException

Overrides the super method and tries to get the class descriptor from a local map. If not found read from the stream and save to local map.

Overrides:

readClassDescriptor in class ObjectInputStream

Returns:

class descriptor

Throws:

IOException

ClassNotFoundException

readStreamHeader

protected void readStreamHeader()
                         throws IOException

Overrides:

readStreamHeader in class ObjectInputStream

Throws:

IOException

closeContext

public void closeContext()

resetContext

public void resetContext()