org.apache.river.api.io

Class AtomicMarshalInputStream

java.lang.Object

java.io.InputStream

java.io.ObjectInputStream

net.jini.io.MarshalInputStream

org.apache.river.api.io.AtomicMarshalInputStream

All Implemented Interfaces:

Closeable, DataInput, ObjectInput, ObjectStreamConstants, AutoCloseable, ObjectStreamContext

public class AtomicMarshalInputStream
extends MarshalInputStream

ObjectInputStream hardened against DOS attack.

De-serialization Not supported:

• private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException
• Object graphs with circular references.
• Object construction using the first non serializable superclass zero arg constructor.

De-serialization Supported:

• Classes annotated with @AtomicSerial, that provide a single GetArg parameter constructor and throw IOException.
• Classes annotated with @AtomicExternal, that provide a single ObjectInput parameter constructor and throw IOException.
• Classes that implement Externalizable
• String's, arrays, enums, primitive values.
• Serializable object's with a public zero arg constructor, with serial forms that contain only primitive fields, any object fields must be marked transient.
• Entry, stream data will be checked against each field type.

Any of the above classes that have the appropriate DeSerializationPermission, Serializable object's that have only primitive serial form, don't require DeSerializationPermission. The Serialization stream protocol.

Informational:

Collection, List Set, SortedSet, Map and SortedMap, are replaced in AtomicObjectOutputStream with immutable implementations that guard against denial of service attacks. These collections are not intended to be used in de-serialized form, other than for passing as an argument to create a new collection. Collections should be type checked during validation before a superclass constructor is called.

AtomicMarshalInputStream is restricted to caching 2^16 objects, and a total combined array length of Integer.MAX_VALUE - 8, for all arrays, the stream must be reset prior to exceeding these limits or a StreamCorruptedException will be thrown and control will return to the caller.

JVM arguments should be adjusted to ensure that an OOME will not be thrown if these limits are reached.

Author:

peter

Nested Class Summary

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, 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
AtomicMarshalInputStream(InputStream input, ClassLoader defaultLoader, boolean verifyCodebaseIntegrity, ClassLoader verifierLoader, Collection context) Constructs a new ObjectInputStream that reads from the InputStream input.
AtomicMarshalInputStream(InputStream input, ClassLoader defaultLoader, boolean verifyCodebaseIntegrity, ClassLoader verifierLoader, Collection context, boolean readAnnotations) Constructs a new ObjectInputStream that reads from the InputStream input.

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes of primitive data that can be read from this stream without blocking.
void	close() Closes this stream.
static ObjectInputStream	create(InputStream in, ClassLoader defaultLoader, boolean verifyCodebaseIntegrity, ClassLoader verifierLoader, Collection context, boolean readAnnotations) The instance returned can de-serialize data written by ObjectOutputStream when readAnnotations is false, it is compatible with MarshalOutputStream when readAnnotations is true.
void	defaultReadObject() Default method to read objects from this stream.
protected boolean	enableResolveObject(boolean enable) Enables object replacement for this stream.
int	read() Reads a single byte from the source stream and returns it as an integer in the range from 0 to 255.
int	read(byte[] buffer, int offset, int length) Reads at most length bytes from the source stream and stores them in byte array buffer starting at offset count.
protected String	readAnnotation() Reads and returns a class annotation string value (possibly null) that was written by a corresponding MarshalOutputStream implementation.
boolean	readBoolean() Reads a boolean from the source stream.
byte	readByte() Reads a byte (8 bit) from the source stream.
char	readChar() Reads a character (16 bit) from the source stream.
protected ObjectStreamClass	readClassDescriptor() Reads a class descriptor from the source stream.
double	readDouble() Reads a double (64 bit) from the source stream.
ObjectInputStream.GetField	readFields() Reads the persistent fields of the object that is currently being read from the source stream.
float	readFloat() Reads a float (32 bit) from the source stream.
void	readFully(byte[] buffer) Reads bytes from the source stream into the byte array buffer.
void	readFully(byte[] buffer, int offset, int length) Reads bytes from the source stream into the byte array buffer.
int	readInt() Reads an integer (32 bit) from the source stream.
String	readLine() Deprecated. Use BufferedReader
long	readLong() Reads a long (64 bit) from the source stream.
<T> T	readObject(Class<T> type) Reads the tc object from the source stream.
protected Object	readObjectOverride() Reads the tc object from the source stream.
short	readShort() Reads a short (16 bit) from the source stream.
protected void	readStreamHeader() Does nothing.
Object	readUnshared() Reads the tc unshared object from the source stream.
<T> T	readUnshared(Class<T> type) Reads the tc unshared object from the source stream.
int	readUnsignedByte() Reads an unsigned byte (8 bit) from the source stream.
int	readUnsignedShort() Reads an unsigned short (16 bit) from the source stream.
String	readUTF() Reads a string encoded in modified UTF-8 from the source stream.
void	registerValidation(ObjectInputValidation object, int priority) Registers a callback for post-deserialization validation of objects.
protected Class	replaceClass(Class c)
protected Object	replaceObject(Object o)
int	skipBytes(int length) Skips length bytes on the source stream.

Methods inherited from class net.jini.io.MarshalInputStream

getDefaultClassLoader, getObjectStreamContext, getVerifierClassLoader, resolveClass, resolveProxyClass, useCodebaseAnnotations

Methods inherited from class java.io.ObjectInputStream

readObject, resolveObject

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

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 Detail

AtomicMarshalInputStream

public AtomicMarshalInputStream(InputStream input,
                                ClassLoader defaultLoader,
                                boolean verifyCodebaseIntegrity,
                                ClassLoader verifierLoader,
                                Collection context)
                         throws IOException

Constructs a new ObjectInputStream that reads from the InputStream input.

Parameters:

input - the non-null source InputStream to filter reads on.

defaultLoader -

verifyCodebaseIntegrity -

verifierLoader -

context -

Throws:

IOException - if an error occurs while reading the stream header.

StreamCorruptedException - if the source stream does not contain serialized objects that can be read.

SecurityException - if a security manager is installed and it denies subclassing this class.

AtomicMarshalInputStream

public AtomicMarshalInputStream(InputStream input,
                                ClassLoader defaultLoader,
                                boolean verifyCodebaseIntegrity,
                                ClassLoader verifierLoader,
                                Collection context,
                                boolean readAnnotations)
                         throws IOException

Constructs a new ObjectInputStream that reads from the InputStream input.

Parameters:

input - the non-null source InputStream to filter reads on.

defaultLoader -

verifyCodebaseIntegrity -

verifierLoader -

context -

readAnnotations - if false is generally compatible with ObjectInputStream otherwise, if true is generally compatible with MarshalInputStream

Throws:

IOException - if an error occurs while reading the stream header.

StreamCorruptedException - if the source stream does not contain serialized objects that can be read.

SecurityException - if a security manager is installed and it denies subclassing this class.

Method Detail

create

public static ObjectInputStream create(InputStream in,
                                       ClassLoader defaultLoader,
                                       boolean verifyCodebaseIntegrity,
                                       ClassLoader verifierLoader,
                                       Collection context,
                                       boolean readAnnotations)
                                throws IOException

The instance returned can de-serialize data written by ObjectOutputStream when readAnnotations is false, it is compatible with MarshalOutputStream when readAnnotations is true.

Parameters:

in -

defaultLoader -

verifyCodebaseIntegrity -

verifierLoader -

context -

readAnnotations - if true, annotations will be read by the stream, note this does not determine whether the annotation will be used, only whether it's read from the stream or not.

Returns:

Throws:

IOException

available

public int available()
              throws IOException

Returns the number of bytes of primitive data that can be read from this stream without blocking. This method should not be used at any arbitrary position; just when reading primitive data types (int, char etc).

Specified by:

available in interface ObjectInput

Overrides:

available in class ObjectInputStream

Returns:

the number of available primitive data bytes.

Throws:

IOException - if any I/O problem occurs while computing the available bytes.

close

public void close()
           throws IOException

Closes this stream. This implementation closes the source stream.

Specified by:

close in interface Closeable

Specified by:

close in interface ObjectInput

Specified by:

close in interface AutoCloseable

Overrides:

close in class ObjectInputStream

Throws:

IOException - if an error occurs while closing this stream.

defaultReadObject

public void defaultReadObject()
                       throws IOException,
                              ClassNotFoundException,
                              NotActiveException

Default method to read objects from this stream. Serializable fields defined in the object's class and superclasses are read from the source stream.

Overrides:

defaultReadObject in class ObjectInputStream

Throws:

ClassNotFoundException - if the object's class cannot be found.

IOException - if an I/O error occurs while reading the object data.

NotActiveException - if this method is not called from readObject().

See Also:

ObjectOutputStream.defaultWriteObject()

enableResolveObject

protected boolean enableResolveObject(boolean enable)
                               throws SecurityException

Enables object replacement for this stream. By default this is not enabled. Only trusted subclasses (loaded with system class loader) are allowed to change this status.

Overrides:

enableResolveObject in class ObjectInputStream

Parameters:

enable - true to enable object replacement; false to disable it.

Returns:

the previous setting.

Throws:

SecurityException - if a security manager is installed and it denies enabling object replacement for this stream.

See Also:

ObjectInputStream.resolveObject(java.lang.Object), ObjectOutputStream.enableReplaceObject(boolean)

read

public int read()
         throws IOException

Reads a single byte from the source stream and returns it as an integer in the range from 0 to 255. Returns -1 if the end of the source stream has been reached. Blocks if no input is available.

Specified by:

read in interface ObjectInput

Overrides:

read in class ObjectInputStream

Returns:

the byte read or -1 if the end of the source stream has been reached.

Throws:

IOException - if an error occurs while reading from this stream.

read

public int read(byte[] buffer,
                int offset,
                int length)
         throws IOException

Reads at most length bytes from the source stream and stores them in byte array buffer starting at offset count. Blocks until count bytes have been read, the end of the source stream is detected or an exception is thrown.

Specified by:

read in interface ObjectInput

Overrides:

read in class ObjectInputStream

Parameters:

buffer - the array in which to store the bytes read.

offset - the initial position in buffer to store the bytes read from the source stream.

length - the maximum number of bytes to store in buffer.

Returns:

the number of bytes read or -1 if the end of the source input stream has been reached.

Throws:

IndexOutOfBoundsException - if offset < 0 or length < 0, or if offset + length is greater than the length of buffer.

IOException - if an error occurs while reading from this stream.

NullPointerException - if buffer is null.

readAnnotation

protected String readAnnotation()
                         throws IOException,
                                ClassNotFoundException

Description copied from class: MarshalInputStream

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

MarshalInputStream implements this method to just read the annotation value from this stream using readObject, and if readObject 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 MarshalInputStream

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

readBoolean

public boolean readBoolean()
                    throws IOException

Reads a boolean from the source stream.

Specified by:

readBoolean in interface DataInput

Overrides:

readBoolean in class ObjectInputStream

Returns:

the boolean value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readByte

public byte readByte()
              throws IOException

Reads a byte (8 bit) from the source stream.

Specified by:

readByte in interface DataInput

Overrides:

readByte in class ObjectInputStream

Returns:

the byte value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readChar

public char readChar()
              throws IOException

Reads a character (16 bit) from the source stream.

Specified by:

readChar in interface DataInput

Overrides:

readChar in class ObjectInputStream

Returns:

the char value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readDouble

public double readDouble()
                  throws IOException

Reads a double (64 bit) from the source stream.

Specified by:

readDouble in interface DataInput

Overrides:

readDouble in class ObjectInputStream

Returns:

the double value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readFields

public ObjectInputStream.GetField readFields()
                                      throws IOException,
                                             ClassNotFoundException,
                                             NotActiveException

Reads the persistent fields of the object that is currently being read from the source stream. The values read are stored in a GetField object that provides access to the persistent fields. This GetField object is then returned.

Overrides:

readFields in class ObjectInputStream

Returns:

the GetField object from which persistent fields can be accessed by name.

Throws:

ClassNotFoundException - if the class of an object being deserialized can not be found.

IOException - if an error occurs while reading from this stream.

NotActiveException - if this stream is currently not reading an object.

readFloat

public float readFloat()
                throws IOException

Reads a float (32 bit) from the source stream.

Specified by:

readFloat in interface DataInput

Overrides:

readFloat in class ObjectInputStream

Returns:

the float value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readFully

public void readFully(byte[] buffer)
               throws IOException

Reads bytes from the source stream into the byte array buffer. This method will block until buffer.length bytes have been read.

Specified by:

readFully in interface DataInput

Overrides:

readFully in class ObjectInputStream

Parameters:

buffer - the array in which to store the bytes read.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readFully

public void readFully(byte[] buffer,
                      int offset,
                      int length)
               throws IOException

Reads bytes from the source stream into the byte array buffer. This method will block until length number of bytes have been read.

Specified by:

readFully in interface DataInput

Overrides:

readFully in class ObjectInputStream

Parameters:

buffer - the byte array in which to store the bytes read.

offset - the initial position in buffer to store the bytes read from the source stream.

length - the maximum number of bytes to store in buffer.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readInt

public int readInt()
            throws IOException

Reads an integer (32 bit) from the source stream.

Specified by:

readInt in interface DataInput

Overrides:

readInt in class ObjectInputStream

Returns:

the integer value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readLine

@Deprecated
public String readLine()
                            throws IOException

Deprecated. Use BufferedReader

Reads the tc line from the source stream. Lines are terminated by '\r', '\n', "\r\n" or an EOF.

Specified by:

readLine in interface DataInput

Overrides:

readLine in class ObjectInputStream

Returns:

the string read from the source stream.

Throws:

IOException - if an error occurs while reading from the source stream.

readLong

public long readLong()
              throws IOException

Reads a long (64 bit) from the source stream.

Specified by:

readLong in interface DataInput

Overrides:

readLong in class ObjectInputStream

Returns:

the long value read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readClassDescriptor

protected final ObjectStreamClass readClassDescriptor()
                                               throws IOException,
                                                      ClassNotFoundException

Reads a class descriptor from the source stream.

Overrides:

readClassDescriptor in class ObjectInputStream

Returns:

the class descriptor read from the source stream.

Throws:

ClassNotFoundException - if a class for one of the objects cannot be found.

IOException - if an error occurs while reading from the source stream.

replaceClass

protected Class replaceClass(Class c)

replaceObject

protected Object replaceObject(Object o)
                        throws IOException,
                               ClassNotFoundException

Throws:

IOException

ClassNotFoundException

readObjectOverride

protected final Object readObjectOverride()
                                   throws OptionalDataException,
                                          ClassNotFoundException,
                                          IOException

Reads the tc object from the source stream.

Overrides:

readObjectOverride in class ObjectInputStream

Returns:

the object read from the source stream.

Throws:

ClassNotFoundException - if the class of one of the objects in the object graph cannot be found.

IOException - if an error occurs while reading from the source stream.

OptionalDataException - if primitive data types were found instead of an object.

OptionalDataException

See Also:

ObjectOutputStream.writeObject(Object)

readObject

public <T> T readObject(Class<T> type)
                 throws IOException,
                        ClassNotFoundException

Reads the tc object from the source stream. In this case, the Object will only be read from the stream if the type matches.

If the stream type doesn't match, AtomicMarshalInputStream will check if the class has a readResolve method and check its annotated with @Serializer with a declared return type. If neither match the expected type, an InvalidObjectException will be thrown.

If no exception is thrown, then AtomicMarshalInputStream will proceed and deserialize the object.

Type Parameters:

T -

Parameters:

type -

Returns:

the new object read.

Throws:

ClassNotFoundException - if the class of one of the objects in the object graph cannot be found.

IOException - if an error occurs while reading from the source stream.

See Also:

ObjectOutputStream.writeUnshared(java.lang.Object)

readUnshared

public Object readUnshared()
                    throws IOException,
                           ClassNotFoundException

Reads the tc unshared object from the source stream.

Overrides:

readUnshared in class ObjectInputStream

Returns:

the new object read.

Throws:

ClassNotFoundException - if the class of one of the objects in the object graph cannot be found.

IOException - if an error occurs while reading from the source stream.

See Also:

ObjectOutputStream.writeUnshared(java.lang.Object)

readUnshared

public <T> T readUnshared(Class<T> type)
                   throws IOException,
                          ClassNotFoundException

Reads the tc unshared object from the source stream. In this case, the Object will only be read from the stream if the type matches.

Parameters:

type - the Class of the object to be read.

Returns:

the new object read.

Throws:

ClassNotFoundException - if the class of one of the objects in the object graph cannot be found.

IOException - if an error occurs while reading from the source stream.

See Also:

ObjectOutputStream.writeUnshared(java.lang.Object)

readShort

public short readShort()
                throws IOException

Reads a short (16 bit) from the source stream.

Specified by:

readShort in interface DataInput

Overrides:

readShort in class ObjectInputStream

Returns:

the short value read from the source stream.

Throws:

IOException - if an error occurs while reading from the source stream.

readStreamHeader

protected final void readStreamHeader()
                               throws IOException,
                                      StreamCorruptedException

Does nothing.

Overrides:

readStreamHeader in class ObjectInputStream

Throws:

IOException - if an error occurs while reading from the source stream.

StreamCorruptedException - if the source stream does not contain readable serialized objects.

readUnsignedByte

public int readUnsignedByte()
                     throws IOException

Reads an unsigned byte (8 bit) from the source stream.

Specified by:

readUnsignedByte in interface DataInput

Overrides:

readUnsignedByte in class ObjectInputStream

Returns:

the unsigned byte value read from the source stream packaged in an integer.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readUnsignedShort

public int readUnsignedShort()
                      throws IOException

Reads an unsigned short (16 bit) from the source stream.

Specified by:

readUnsignedShort in interface DataInput

Overrides:

readUnsignedShort in class ObjectInputStream

Returns:

the unsigned short value read from the source stream packaged in an integer.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

readUTF

public String readUTF()
               throws IOException

Reads a string encoded in modified UTF-8 from the source stream.

Specified by:

readUTF in interface DataInput

Overrides:

readUTF in class ObjectInputStream

Returns:

the string encoded in modified UTF-8 read from the source stream.

Throws:

EOFException - if the end of the input is reached before the read request can be satisfied.

IOException - if an error occurs while reading from the source stream.

registerValidation

public void registerValidation(ObjectInputValidation object,
                               int priority)
                        throws NotActiveException,
                               InvalidObjectException

Registers a callback for post-deserialization validation of objects. It allows to perform additional consistency checks before the readObject() method of this class returns its result to the caller. This method can only be called from within the readObject() method of a class that implements "special" deserialization rules. It can be called multiple times. Validation callbacks are then done in order of decreasing priority, defined by priority.

Overrides:

registerValidation in class ObjectInputStream

Parameters:

object - an object that can validate itself by receiving a callback.

priority - the validator's priority.

Throws:

InvalidObjectException - if object is null.

NotActiveException - if this stream is currently not reading objects. In that case, calling this method is not allowed.

See Also:

ObjectInputValidation.validateObject()

skipBytes

public int skipBytes(int length)
              throws IOException

Skips length bytes on the source stream. This method should not be used to skip bytes at any arbitrary position, just when reading primitive data types (int, char etc).

Specified by:

skipBytes in interface DataInput

Overrides:

skipBytes in class ObjectInputStream

Parameters:

length - the number of bytes to skip.

Returns:

the number of bytes actually skipped.

Throws:

IOException - if an error occurs while skipping bytes on the source stream.

NullPointerException - if the source stream is null.