Hessian2Input (Hessian 4.0.38 API)

java.lang.Object
- com.caucho.hessian.io.AbstractHessianInput
- - com.caucho.hessian.io.Hessian2Input

All Implemented Interfaces:: Hessian2Constants

Direct Known Subclasses:: HessianSerializerInput

public class Hessian2Input
extends AbstractHessianInput
implements Hessian2Constants

Input stream for Hessian requests.

HessianInput is unbuffered, so any client needs to provide its own buffering.

 InputStream is = ...; // from http connection
 HessianInput in = new HessianInput(is);
 String value;

 in.startReply();         // read reply header
 value = in.readString(); // read string value
 in.completeReply();      // read reply footer

Field Summary

Fields
Modifier and Type	Field and Description
`protected ArrayList<com.caucho.hessian.io.Hessian2Input.ObjectDefinition>`	`_classDefs`
`protected SerializerFactory`	`_defaultSerializerFactory`
`protected ArrayList<Object>`	`_refs`
`protected SerializerFactory`	`_serializerFactory`
`protected ArrayList<String>`	`_types`

Fields inherited from interface com.caucho.hessian.io.Hessian2Constants
BC_BINARY, BC_BINARY_CHUNK, BC_BINARY_DIRECT, BC_BINARY_SHORT, BC_CLASS_DEF, BC_DATE, BC_DATE_MINUTE, BC_DOUBLE, BC_DOUBLE_BYTE, BC_DOUBLE_MILL, BC_DOUBLE_ONE, BC_DOUBLE_SHORT, BC_DOUBLE_ZERO, BC_END, BC_FALSE, BC_INT, BC_INT_BYTE_ZERO, BC_INT_SHORT_ZERO, BC_INT_ZERO, BC_LIST_DIRECT, BC_LIST_DIRECT_UNTYPED, BC_LIST_FIXED, BC_LIST_FIXED_UNTYPED, BC_LIST_VARIABLE, BC_LIST_VARIABLE_UNTYPED, BC_LONG, BC_LONG_BYTE_ZERO, BC_LONG_INT, BC_LONG_SHORT_ZERO, BC_LONG_ZERO, BC_MAP, BC_MAP_UNTYPED, BC_NULL, BC_OBJECT, BC_OBJECT_DEF, BC_OBJECT_DIRECT, BC_REF, BC_STRING, BC_STRING_CHUNK, BC_STRING_DIRECT, BC_STRING_SHORT, BC_TRUE, BINARY_DIRECT_MAX, BINARY_SHORT_MAX, INT_BYTE_MAX, INT_BYTE_MIN, INT_DIRECT_MAX, INT_DIRECT_MIN, INT_SHORT_MAX, INT_SHORT_MIN, LIST_DIRECT_MAX, LONG_BYTE_MAX, LONG_BYTE_MIN, LONG_DIRECT_MAX, LONG_DIRECT_MIN, LONG_SHORT_MAX, LONG_SHORT_MIN, OBJECT_DIRECT_MAX, P_PACKET, P_PACKET_CHUNK, P_PACKET_DIRECT, P_PACKET_SHORT, PACKET_DIRECT_MAX, PACKET_SHORT_MAX, STRING_DIRECT_MAX, STRING_SHORT_MAX

Constructor Summary

Constructors
Constructor and Description

Hessian2Input()

Hessian2Input(InputStream is)
Creates a new Hessian input stream, initialized with an underlying input stream.

Constructors
Constructor and Description
`Hessian2Input()`
`Hessian2Input(InputStream is)` Creates a new Hessian input stream, initialized with an underlying input stream.

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`addRef(Object ref)` Adds a list/map reference.
`void`	`close()`
`protected String`	`codeName(int ch)`
`void`	`completeCall()` Completes reading the call A successful completion will have a single value:
`void`	`completeEnvelope()` Completes reading the envelope A successful completion will have a single value: Z
`void`	`completeMessage()` Completes reading the message A successful completion will have a single value: z
`void`	`completeReply()` Completes reading the call A successful completion will have a single value: z
`void`	`completeValueReply()` Completes reading the call A successful completion will have a single value: z
`protected IOException`	`error(String message)`
`protected IOException`	`expect(String expect, int ch)`
`protected SerializerFactory`	`findSerializerFactory()` Gets the serializer factory.
`void`	`free()`
`String`	`getMethod()` Returns the calls method
`Reader`	`getReader()` Starts reading a string.
`Throwable`	`getReplyFault()` Returns any reply fault.
`SerializerFactory`	`getSerializerFactory()` Gets the serializer factory.
`void`	`init(InputStream is)` Initialize the Hessian stream with the underlying input stream.
`void`	`initPacket(InputStream is)`
`boolean`	`isCloseStreamOnClose()`
`boolean`	`isEnd()` Returns true if this is the end of a list or a map.
`int`	`read()` Normally, shouldn't be called externally, but needed for QA, e.g.
`Object[]`	`readArguments()`
`boolean`	`readBoolean()` Reads a boolean T F
`int`	`readByte()` Reads a byte from the stream.
`byte[]`	`readBytes()` Reads a byte array B b16 b8 data value
`int`	`readBytes(byte[] buffer, int offset, int length)` Reads a byte array from the stream.
`int`	`readCall()` Starts reading the call c major minor
`int`	`readChar()` Reads a byte from the stream.
`double`	`readDouble()` Reads a double D b64 b56 b48 b40 b32 b24 b16 b8
`void`	`readEnd()` Reads the end byte.
`int`	`readEnvelope()` Starts reading the envelope E major minor
`float`	`readFloat()` Reads a float D b64 b56 b48 b40 b32 b24 b16 b8
`String`	`readHeader()` Reads a header, returning null if there are no headers.
`InputStream`	`readInputStream()` Reads bytes based on an input stream.
`int`	`readInt()` Reads an integer I b32 b24 b16 b8
`int`	`readLength()` Parses the length for an array l b32 b24 b16 b8
`void`	`readListEnd()` Reads the end byte.
`int`	`readListStart()` Reads the start of a list.
`long`	`readLong()` Reads a long L b64 b56 b48 b40 b32 b24 b16 b8
`void`	`readMapEnd()` Reads the end byte.
`int`	`readMapStart()` Reads the start of a list.
`String`	`readMethod()` Starts reading the call A successful completion will have a single value: string
`int`	`readMethodArgLength()` Returns the number of method arguments int
`void`	`readNull()` Reads a null N
`Object`	`readObject()` Reads an arbitrary object from the input stream when the type is unknown.
`Object`	`readObject(Class cl)` Reads an object from the input stream with an expected type.
`Object`	`readRef()` Reads a reference.
`Object`	`readRemote()` Reads a remote object.
`Object`	`readReply(Class expectedClass)` Reads a reply as an object.
`short`	`readShort()` Reads a short I b32 b24 b16 b8
`Object`	`readStreamingObject()`
`String`	`readString()` Reads a string S b16 b8 string value
`int`	`readString(char[] buffer, int offset, int length)` Reads a byte array from the stream.
`String`	`readType()` Parses a type from the stream.
`long`	`readUTCDate()` Reads a date.
`void`	`reset()`
`void`	`resetBuffer()`
`void`	`resetReferences()` Resets the references for streaming.
`Object`	`resolveRemote(String type, String url)` Resolves a remote object.
`void`	`setCloseStreamOnClose(boolean isClose)`
`void`	`setRef(int i, Object ref)` Adds a list/map reference.
`void`	`setSerializerFactory(SerializerFactory factory)` Sets the serializer factory.
`void`	`startCall()` Starts reading the call, including the headers.
`int`	`startMessage()` Starts reading a packet p major minor
`void`	`startReply()` Starts reading the reply A successful completion will have a single value: r
`protected void`	`unread()`

Methods inherited from class com.caucho.hessian.io.AbstractHessianInput
getRemoteResolver, readNode, readToOutputStream, setRemoteResolver, skipOptionalCall, startReplyBody

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _defaultSerializerFactory
```
protected SerializerFactory _defaultSerializerFactory
```
  - _serializerFactory
```
protected SerializerFactory _serializerFactory
```
  - _refs
```
protected ArrayList<Object> _refs
```
  - _classDefs
```
protected ArrayList<com.caucho.hessian.io.Hessian2Input.ObjectDefinition> _classDefs
```
  - _types
```
protected ArrayList<String> _types
```
- Constructor Detail
  - Hessian2Input
```
public Hessian2Input()
```
  - Hessian2Input
```
public Hessian2Input(InputStream is)
```
    Creates a new Hessian input stream, initialized with an underlying input stream.
    
    Parameters:
    is - the underlying input stream.
- Method Detail
  - setSerializerFactory
```
public void setSerializerFactory(SerializerFactory factory)
```
    Sets the serializer factory.
    
    Overrides:
    
    setSerializerFactory in class AbstractHessianInput
  - getSerializerFactory
```
public SerializerFactory getSerializerFactory()
```
    Gets the serializer factory.
  - findSerializerFactory
```
protected final SerializerFactory findSerializerFactory()
```
    Gets the serializer factory.
  - setCloseStreamOnClose
```
public void setCloseStreamOnClose(boolean isClose)
```
  - isCloseStreamOnClose
```
public boolean isCloseStreamOnClose()
```
  - getMethod
```
public String getMethod()
```
    Returns the calls method
    
    Specified by:
    
    getMethod in class AbstractHessianInput
  - getReplyFault
```
public Throwable getReplyFault()
```
    Returns any reply fault.
  - init
```
public void init(InputStream is)
```
    Description copied from class: AbstractHessianInput
    
    Initialize the Hessian stream with the underlying input stream.
    
    Overrides:
    
    init in class AbstractHessianInput
  - initPacket
```
public void initPacket(InputStream is)
```
  - readCall
```
public int readCall()
             throws IOException
```
    Starts reading the call
```
 c major minor
 
```
    Specified by:
    
    readCall in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readEnvelope
```
public int readEnvelope()
                 throws IOException
```
    Starts reading the envelope
```
 E major minor
 
```
    Throws:
    
    IOException
  - completeEnvelope
```
public void completeEnvelope()
                      throws IOException
```
    Completes reading the envelope
    A successful completion will have a single value:
```
 Z
 
```
    Throws:
    
    IOException
  - readMethod
```
public String readMethod()
                  throws IOException
```
    Starts reading the call
    A successful completion will have a single value:
```
 string
 
```
    Specified by:
    
    readMethod in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readMethodArgLength
```
public int readMethodArgLength()
                        throws IOException
```
    Returns the number of method arguments
```
 int
 
```
    Overrides:
    
    readMethodArgLength in class AbstractHessianInput
    
    Returns:
    -1 for a variable length (hessian 1.0)
    
    Throws:
    
    IOException
  - startCall
```
public void startCall()
               throws IOException
```
    Starts reading the call, including the headers.
    The call expects the following protocol data
```
 c major minor
 m b16 b8 method
 
```
    Specified by:
    
    startCall in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readArguments
```
public Object[] readArguments()
                       throws IOException
```
    Throws:
    
    IOException
  - completeCall
```
public void completeCall()
                  throws IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 
```
    Specified by:
    
    completeCall in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readReply
```
public Object readReply(Class expectedClass)
                 throws Throwable
```
    Reads a reply as an object. If the reply has a fault, throws the exception.
    
    Specified by:
    
    readReply in class AbstractHessianInput
    
    Throws:
    
    Throwable
  - startReply
```
public void startReply()
                throws Throwable
```
    Starts reading the reply
    A successful completion will have a single value:
```
 r
 
```
    Specified by:
    
    startReply in class AbstractHessianInput
    
    Throws:
    
    Throwable
  - completeReply
```
public void completeReply()
                   throws IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 z
 
```
    Specified by:
    
    completeReply in class AbstractHessianInput
    
    Throws:
    
    IOException
  - completeValueReply
```
public void completeValueReply()
                        throws IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 z
 
```
    Throws:
    
    IOException
  - readHeader
```
public String readHeader()
                  throws IOException
```
    Reads a header, returning null if there are no headers.
```
 H b16 b8 value
 
```
    Specified by:
    
    readHeader in class AbstractHessianInput
    
    Throws:
    
    IOException
  - startMessage
```
public int startMessage()
                 throws IOException
```
    Starts reading a packet
```
 p major minor
 
```
    Throws:
    
    IOException
  - completeMessage
```
public void completeMessage()
                     throws IOException
```
    Completes reading the message
    A successful completion will have a single value:
```
 z
 
```
    Throws:
    
    IOException
  - readNull
```
public void readNull()
              throws IOException
```
    Reads a null
```
 N
 
```
    Specified by:
    
    readNull in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readBoolean
```
public boolean readBoolean()
                    throws IOException
```
    Reads a boolean
```
 T
 F
 
```
    Specified by:
    
    readBoolean in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readShort
```
public short readShort()
                throws IOException
```
    Reads a short
```
 I b32 b24 b16 b8
 
```
    Throws:
    
    IOException
  - readInt
```
public final int readInt()
                  throws IOException
```
    Reads an integer
```
 I b32 b24 b16 b8
 
```
    Specified by:
    
    readInt in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readLong
```
public long readLong()
              throws IOException
```
    Reads a long
```
 L b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readLong in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Reads a float
```
 D b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Reads a double
```
 D b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readDouble in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readUTCDate
```
public long readUTCDate()
                 throws IOException
```
    Reads a date.
```
 T b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readUTCDate in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readChar
```
public int readChar()
             throws IOException
```
    Reads a byte from the stream.
    
    Throws:
    
    IOException
  - readString
```
public int readString(char[] buffer,
             int offset,
             int length)
               throws IOException
```
    Reads a byte array from the stream.
    
    Throws:
    
    IOException
  - readString
```
public String readString()
                  throws IOException
```
    Reads a string
```
 S b16 b8 string value
 
```
    Specified by:
    
    readString in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readBytes
```
public byte[] readBytes()
                 throws IOException
```
    Reads a byte array
```
 B b16 b8 data value
 
```
    Specified by:
    
    readBytes in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readByte
```
public int readByte()
             throws IOException
```
    Reads a byte from the stream.
    
    Throws:
    
    IOException
  - readBytes
```
public int readBytes(byte[] buffer,
            int offset,
            int length)
              throws IOException
```
    Reads a byte array from the stream.
    
    Throws:
    
    IOException
  - readObject
```
public Object readObject(Class cl)
                  throws IOException
```
    Reads an object from the input stream with an expected type.
    
    Specified by:
    
    readObject in class AbstractHessianInput
    
    Parameters:
    cl - the expected class if the protocol doesn't supply it.
    
    Throws:
    
    IOException
  - readObject
```
public Object readObject()
                  throws IOException
```
    Reads an arbitrary object from the input stream when the type is unknown.
    
    Specified by:
    
    readObject in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readRemote
```
public Object readRemote()
                  throws IOException
```
    Reads a remote object.
    
    Specified by:
    
    readRemote in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readRef
```
public Object readRef()
               throws IOException
```
    Reads a reference.
    
    Specified by:
    
    readRef in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readListStart
```
public int readListStart()
                  throws IOException
```
    Reads the start of a list.
    
    Specified by:
    
    readListStart in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readMapStart
```
public int readMapStart()
                 throws IOException
```
    Reads the start of a list.
    
    Specified by:
    
    readMapStart in class AbstractHessianInput
    
    Throws:
    
    IOException
  - isEnd
```
public boolean isEnd()
              throws IOException
```
    Returns true if this is the end of a list or a map.
    
    Specified by:
    
    isEnd in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readEnd
```
public void readEnd()
             throws IOException
```
    Reads the end byte.
    
    Specified by:
    
    readEnd in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readMapEnd
```
public void readMapEnd()
                throws IOException
```
    Reads the end byte.
    
    Specified by:
    
    readMapEnd in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readListEnd
```
public void readListEnd()
                 throws IOException
```
    Reads the end byte.
    
    Specified by:
    
    readListEnd in class AbstractHessianInput
    
    Throws:
    
    IOException
  - addRef
```
public int addRef(Object ref)
```
    Adds a list/map reference.
    
    Specified by:
    
    addRef in class AbstractHessianInput
  - setRef
```
public void setRef(int i,
          Object ref)
```
    Adds a list/map reference.
    
    Specified by:
    
    setRef in class AbstractHessianInput
  - resetReferences
```
public void resetReferences()
```
    Resets the references for streaming.
    
    Overrides:
    
    resetReferences in class AbstractHessianInput
  - reset
```
public void reset()
```
  - resetBuffer
```
public void resetBuffer()
```
  - readStreamingObject
```
public Object readStreamingObject()
                           throws IOException
```
    Throws:
    
    IOException
  - resolveRemote
```
public Object resolveRemote(String type,
                   String url)
                     throws IOException
```
    Resolves a remote object.
    
    Throws:
    
    IOException
  - readType
```
public String readType()
                throws IOException
```
    Parses a type from the stream.
```
 type ::= string
 type ::= int
 
```
    Specified by:
    
    readType in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readLength
```
public int readLength()
               throws IOException
```
    Parses the length for an array
```
 l b32 b24 b16 b8
 
```
    Specified by:
    
    readLength in class AbstractHessianInput
    
    Throws:
    
    IOException
  - readInputStream
```
public InputStream readInputStream()
                            throws IOException
```
    Reads bytes based on an input stream.
    
    Specified by:
    
    readInputStream in class AbstractHessianInput
    
    Throws:
    
    IOException
  - read
```
public final int read()
               throws IOException
```
    Normally, shouldn't be called externally, but needed for QA, e.g. ejb/3b01.
    
    Throws:
    
    IOException
  - unread
```
protected void unread()
```
  - getReader
```
public Reader getReader()
```
    Description copied from class: AbstractHessianInput
    Starts reading a string. All the characters must be read before calling the next method. The actual characters will be read with the reader's read() or read(char [], int, int).
```
 s b16 b8 non-final string chunk
 S b16 b8 final string chunk
 
```
    Specified by:
    
    getReader in class AbstractHessianInput
  - expect
```
protected IOException expect(String expect,
                 int ch)
                      throws IOException
```
    Throws:
    
    IOException
  - codeName
```
protected String codeName(int ch)
```
  - error
```
protected IOException error(String message)
```
  - free
```
public void free()
```
  - close
```
public void close()
           throws IOException
```
    Overrides:
    
    close in class AbstractHessianInput
    
    Throws:
    
    IOException

Class Hessian2Input

Field Summary

Fields inherited from interface com.caucho.hessian.io.Hessian2Constants

Constructor Summary

Method Summary

Methods inherited from class com.caucho.hessian.io.AbstractHessianInput

Methods inherited from class java.lang.Object

Field Detail

_defaultSerializerFactory

_serializerFactory

_refs

_classDefs

_types

Constructor Detail

Hessian2Input

Hessian2Input

Method Detail

setSerializerFactory

getSerializerFactory

findSerializerFactory

setCloseStreamOnClose

isCloseStreamOnClose

getMethod

getReplyFault

init

initPacket

readCall

readEnvelope

completeEnvelope

readMethod

readMethodArgLength

startCall

readArguments

completeCall

readReply

startReply

completeReply

completeValueReply

readHeader

startMessage

completeMessage

readNull

readBoolean

readShort

readInt

readLong

readFloat

readDouble

readUTCDate

readChar

readString

readString

readBytes

readByte

readBytes

readObject

readObject

readRemote

readRef

readListStart

readMapStart

isEnd

readEnd

readMapEnd

readListEnd

addRef

setRef

resetReferences

reset

resetBuffer

readStreamingObject

resolveRemote

readType

readLength

readInputStream

read

unread

getReader

expect

codeName