HessianInput

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

public class HessianInput
extends AbstractHessianInput

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
`private java.io.InputStream`	`_chunkInputStream`
`private int`	`_chunkLength`
`private java.io.Reader`	`_chunkReader`
`private static java.lang.reflect.Field`	`_detailMessageField`
`private java.io.InputStream`	`_is`
`private boolean`	`_isLastChunk`
`private java.lang.String`	`_method`
`protected int`	`_peek`
`protected java.util.ArrayList`	`_refs`
`private java.lang.Throwable`	`_replyFault`
`private java.lang.StringBuffer`	`_sbuf`
`protected SerializerFactory`	`_serializerFactory`
`private static int`	`END_OF_DATA`

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addRef(java.lang.Object ref)` Adds a list/map reference.
`void`	`close()`
`protected java.lang.String`	`codeName(int ch)`
`void`	`completeCall()` Completes reading the call
`void`	`completeReply()` Completes reading the call
`void`	`completeValueReply()` Completes reading the call
`protected java.io.IOException`	`error(java.lang.String message)`
`protected java.io.IOException`	`expect(java.lang.String expect, int ch)`
`java.lang.String`	`getMethod()` Returns the calls method
`java.io.Reader`	`getReader()` Starts reading a string.
`java.lang.Throwable`	`getReplyFault()` Returns any reply fault.
`SerializerFactory`	`getSerializerFactory()` Gets the serializer factory.
`void`	`init(java.io.InputStream is)` Initialize the hessian stream with the underlying input stream.
`boolean`	`isEnd()` Returns true if this is the end of a list or a map.
`private int`	`parseByte()` Reads a byte from the underlying stream.
`private int`	`parseChar()` Reads a character from the underlying stream.
`private double`	`parseDouble()` Parses a 64-bit double value from the stream.
`private int`	`parseInt()` Parses a 32-bit integer value from the stream.
`private long`	`parseLong()` Parses a 64-bit long value from the stream.
`private int`	`parseUTF8Char()` Parses a single UTF8 character.
`(package private) org.w3c.dom.Node`	`parseXML()`
`private java.lang.Throwable`	`prepareFault()` Prepares the fault.
`(package private) int`	`read()`
`(package private) int`	`read(byte[] buffer, int offset, int length)` Reads bytes from the underlying stream.
`boolean`	`readBoolean()` Reads a boolean
`int`	`readByte()` Reads a byte from the stream.
`byte[]`	`readBytes()` Reads a byte array
`int`	`readBytes(byte[] buffer, int offset, int length)` Reads a byte array from the stream.
`int`	`readCall()` Starts reading the call
`int`	`readChar()` Reads a byte from the stream.
`double`	`readDouble()` Reads a double
`void`	`readEnd()` Reads the end byte.
`private java.util.HashMap`	`readFault()` Reads a fault.
`float`	`readFloat()` Reads a float
`java.lang.String`	`readHeader()` Reads a header, returning null if there are no headers.
`java.io.InputStream`	`readInputStream()` Reads bytes based on an input stream.
`int`	`readInt()` Reads an integer
`int`	`readLength()` Parses the length for an array
`void`	`readListEnd()` Reads the end byte.
`int`	`readListStart()` Reads the start of a list.
`long`	`readLong()` Reads a long
`void`	`readMapEnd()` Reads the end byte.
`int`	`readMapStart()` Reads the start of a list.
`java.lang.String`	`readMethod()` Starts reading the call
`org.w3c.dom.Node`	`readNode()` Reads an XML node.
`void`	`readNull()` Reads a null
`java.lang.Object`	`readObject()` Reads an arbitrary object from the input stream when the type is unknown.
`java.lang.Object`	`readObject(java.lang.Class cl)` Reads an object from the input stream with an expected type.
`java.lang.Object`	`readRef()` Reads a reference.
`java.lang.Object`	`readRemote()` Reads a remote object.
`java.lang.Object`	`readReply(java.lang.Class expectedClass)` Reads a reply as an object.
`short`	`readShort()` Reads a short
`java.lang.String`	`readString()` Reads a string
`int`	`readString(char[] buffer, int offset, int length)` Reads a byte array from the stream.
`java.lang.String`	`readType()` Parses a type from the stream.
`long`	`readUTCDate()` Reads a date.
`void`	`resetReferences()` Resets the references for streaming.
`java.lang.Object`	`resolveRemote(java.lang.String type, java.lang.String url)` Resolves a remote object.
`void`	`setRef(int i, java.lang.Object ref)` Adds a list/map reference.
`void`	`setSerializerFactory(SerializerFactory factory)` Sets the serializer factory.
`void`	`skipOptionalCall()` For backward compatibility with HessianSkeleton
`void`	`startCall()` Starts reading the call, including the headers.
`void`	`startReply()` Starts reading the reply
`void`	`startReplyBody()` Starts reading the body of the reply, i.e.

Methods inherited from class com.caucho.hessian.io.AbstractHessianInput
getRemoteResolver, readMethodArgLength, readToOutputStream, setRemoteResolver

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

- Field Detail
  - END_OF_DATA
```
private static int END_OF_DATA
```
  - _detailMessageField
```
private static java.lang.reflect.Field _detailMessageField
```
  - _serializerFactory
```
protected SerializerFactory _serializerFactory
```
  - _refs
```
protected java.util.ArrayList _refs
```
  - _is
```
private java.io.InputStream _is
```
  - _peek
```
protected int _peek
```
  - _method
```
private java.lang.String _method
```
  - _chunkReader
```
private java.io.Reader _chunkReader
```
  - _chunkInputStream
```
private java.io.InputStream _chunkInputStream
```
  - _replyFault
```
private java.lang.Throwable _replyFault
```
  - _sbuf
```
private java.lang.StringBuffer _sbuf
```
  - _isLastChunk
```
private boolean _isLastChunk
```
  - _chunkLength
```
private int _chunkLength
```
- Constructor Detail
  - HessianInput
```
public HessianInput()
```
    Creates an uninitialized Hessian input stream.
  - HessianInput
```
public HessianInput(java.io.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.
  - init
```
public void init(java.io.InputStream is)
```
    Initialize the hessian stream with the underlying input stream.
    
    Overrides:
    
    init in class AbstractHessianInput
  - getMethod
```
public java.lang.String getMethod()
```
    Returns the calls method
    
    Specified by:
    
    getMethod in class AbstractHessianInput
  - getReplyFault
```
public java.lang.Throwable getReplyFault()
```
    Returns any reply fault.
  - readCall
```
public int readCall()
             throws java.io.IOException
```
    Starts reading the call
```
 c major minor
 
```
    Specified by:
    
    readCall in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - skipOptionalCall
```
public void skipOptionalCall()
                      throws java.io.IOException
```
    For backward compatibility with HessianSkeleton
    
    Overrides:
    
    skipOptionalCall in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readMethod
```
public java.lang.String readMethod()
                            throws java.io.IOException
```
    Starts reading the call
    A successful completion will have a single value:
```
 m b16 b8 method
 
```
    Specified by:
    
    readMethod in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - startCall
```
public void startCall()
               throws java.io.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:
    
    java.io.IOException
  - completeCall
```
public void completeCall()
                  throws java.io.IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 z
 
```
    Specified by:
    
    completeCall in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readReply
```
public java.lang.Object readReply(java.lang.Class expectedClass)
                           throws java.lang.Throwable
```
    Reads a reply as an object. If the reply has a fault, throws the exception.
    
    Specified by:
    
    readReply in class AbstractHessianInput
    
    Throws:
    
    java.lang.Throwable
  - startReply
```
public void startReply()
                throws java.lang.Throwable
```
    Starts reading the reply
    A successful completion will have a single value:
```
 r
 
```
    Specified by:
    
    startReply in class AbstractHessianInput
    
    Throws:
    
    java.lang.Throwable
  - startReplyBody
```
public void startReplyBody()
                    throws java.lang.Throwable
```
    Description copied from class: AbstractHessianInput
    
    Starts reading the body of the reply, i.e. after the 'r' has been parsed.
    
    Overrides:
    
    startReplyBody in class AbstractHessianInput
    
    Throws:
    
    java.lang.Throwable
  - prepareFault
```
private java.lang.Throwable prepareFault()
                                  throws java.io.IOException
```
    Prepares the fault.
    
    Throws:
    
    java.io.IOException
  - completeReply
```
public void completeReply()
                   throws java.io.IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 z
 
```
    Specified by:
    
    completeReply in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - completeValueReply
```
public void completeValueReply()
                        throws java.io.IOException
```
    Completes reading the call
    A successful completion will have a single value:
```
 z
 
```
    Throws:
    
    java.io.IOException
  - readHeader
```
public java.lang.String readHeader()
                            throws java.io.IOException
```
    Reads a header, returning null if there are no headers.
```
 H b16 b8 value
 
```
    Specified by:
    
    readHeader in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readNull
```
public void readNull()
              throws java.io.IOException
```
    Reads a null
```
 N
 
```
    Specified by:
    
    readNull in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readBoolean
```
public boolean readBoolean()
                    throws java.io.IOException
```
    Reads a boolean
```
 T
 F
 
```
    Specified by:
    
    readBoolean in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readShort
```
public short readShort()
                throws java.io.IOException
```
    Reads a short
```
 I b32 b24 b16 b8
 
```
    Throws:
    
    java.io.IOException
  - readInt
```
public int readInt()
            throws java.io.IOException
```
    Reads an integer
```
 I b32 b24 b16 b8
 
```
    Specified by:
    
    readInt in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readLong
```
public long readLong()
              throws java.io.IOException
```
    Reads a long
```
 L b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readLong in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readFloat
```
public float readFloat()
                throws java.io.IOException
```
    Reads a float
```
 D b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Throws:
    
    java.io.IOException
  - readDouble
```
public double readDouble()
                  throws java.io.IOException
```
    Reads a double
```
 D b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readDouble in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readUTCDate
```
public long readUTCDate()
                 throws java.io.IOException
```
    Reads a date.
```
 T b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Specified by:
    
    readUTCDate in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readChar
```
public int readChar()
             throws java.io.IOException
```
    Reads a byte from the stream.
    
    Throws:
    
    java.io.IOException
  - readString
```
public int readString(char[] buffer,
                      int offset,
                      int length)
               throws java.io.IOException
```
    Reads a byte array from the stream.
    
    Throws:
    
    java.io.IOException
  - readString
```
public java.lang.String readString()
                            throws java.io.IOException
```
    Reads a string
```
 S b16 b8 string value
 
```
    Specified by:
    
    readString in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readNode
```
public org.w3c.dom.Node readNode()
                          throws java.io.IOException
```
    Reads an XML node.
```
 S b16 b8 string value
 
```
    Overrides:
    
    readNode in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readBytes
```
public byte[] readBytes()
                 throws java.io.IOException
```
    Reads a byte array
```
 B b16 b8 data value
 
```
    Specified by:
    
    readBytes in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readByte
```
public int readByte()
             throws java.io.IOException
```
    Reads a byte from the stream.
    
    Throws:
    
    java.io.IOException
  - readBytes
```
public int readBytes(byte[] buffer,
                     int offset,
                     int length)
              throws java.io.IOException
```
    Reads a byte array from the stream.
    
    Throws:
    
    java.io.IOException
  - readFault
```
private java.util.HashMap readFault()
                             throws java.io.IOException
```
    Reads a fault.
    
    Throws:
    
    java.io.IOException
  - readObject
```
public java.lang.Object readObject(java.lang.Class cl)
                            throws java.io.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:
    
    java.io.IOException
  - readObject
```
public java.lang.Object readObject()
                            throws java.io.IOException
```
    Reads an arbitrary object from the input stream when the type is unknown.
    
    Specified by:
    
    readObject in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readRemote
```
public java.lang.Object readRemote()
                            throws java.io.IOException
```
    Reads a remote object.
    
    Specified by:
    
    readRemote in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readRef
```
public java.lang.Object readRef()
                         throws java.io.IOException
```
    Reads a reference.
    
    Specified by:
    
    readRef in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readListStart
```
public int readListStart()
                  throws java.io.IOException
```
    Reads the start of a list.
    
    Specified by:
    
    readListStart in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readMapStart
```
public int readMapStart()
                 throws java.io.IOException
```
    Reads the start of a list.
    
    Specified by:
    
    readMapStart in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - isEnd
```
public boolean isEnd()
              throws java.io.IOException
```
    Returns true if this is the end of a list or a map.
    
    Specified by:
    
    isEnd in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readEnd
```
public void readEnd()
             throws java.io.IOException
```
    Reads the end byte.
    
    Specified by:
    
    readEnd in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readMapEnd
```
public void readMapEnd()
                throws java.io.IOException
```
    Reads the end byte.
    
    Specified by:
    
    readMapEnd in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readListEnd
```
public void readListEnd()
                 throws java.io.IOException
```
    Reads the end byte.
    
    Specified by:
    
    readListEnd in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - addRef
```
public int addRef(java.lang.Object ref)
```
    Adds a list/map reference.
    
    Specified by:
    
    addRef in class AbstractHessianInput
  - setRef
```
public void setRef(int i,
                   java.lang.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
  - resolveRemote
```
public java.lang.Object resolveRemote(java.lang.String type,
                                      java.lang.String url)
                               throws java.io.IOException
```
    Resolves a remote object.
    
    Throws:
    
    java.io.IOException
  - readType
```
public java.lang.String readType()
                          throws java.io.IOException
```
    Parses a type from the stream.
```
 t b16 b8
 
```
    Specified by:
    
    readType in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - readLength
```
public int readLength()
               throws java.io.IOException
```
    Parses the length for an array
```
 l b32 b24 b16 b8
 
```
    Specified by:
    
    readLength in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - parseInt
```
private int parseInt()
              throws java.io.IOException
```
    Parses a 32-bit integer value from the stream.
```
 b32 b24 b16 b8
 
```
    Throws:
    
    java.io.IOException
  - parseLong
```
private long parseLong()
                throws java.io.IOException
```
    Parses a 64-bit long value from the stream.
```
 b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Throws:
    
    java.io.IOException
  - parseDouble
```
private double parseDouble()
                    throws java.io.IOException
```
    Parses a 64-bit double value from the stream.
```
 b64 b56 b48 b40 b32 b24 b16 b8
 
```
    Throws:
    
    java.io.IOException
  - parseXML
```
org.w3c.dom.Node parseXML()
                   throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - parseChar
```
private int parseChar()
               throws java.io.IOException
```
    Reads a character from the underlying stream.
    
    Throws:
    
    java.io.IOException
  - parseUTF8Char
```
private int parseUTF8Char()
                   throws java.io.IOException
```
    Parses a single UTF8 character.
    
    Throws:
    
    java.io.IOException
  - parseByte
```
private int parseByte()
               throws java.io.IOException
```
    Reads a byte from the underlying stream.
    
    Throws:
    
    java.io.IOException
  - readInputStream
```
public java.io.InputStream readInputStream()
                                    throws java.io.IOException
```
    Reads bytes based on an input stream.
    
    Specified by:
    
    readInputStream in class AbstractHessianInput
    
    Throws:
    
    java.io.IOException
  - read
```
int read(byte[] buffer,
         int offset,
         int length)
  throws java.io.IOException
```
    Reads bytes from the underlying stream.
    
    Throws:
    
    java.io.IOException
  - read
```
final int read()
        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - close
```
public void close()
```
    Overrides:
    
    close in class AbstractHessianInput
  - getReader
```
public java.io.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 java.io.IOException expect(java.lang.String expect,
                                     int ch)
```
  - codeName
```
protected java.lang.String codeName(int ch)
```
  - error
```
protected java.io.IOException error(java.lang.String message)
```

Class HessianInput

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

END_OF_DATA

_detailMessageField

_serializerFactory

_refs

_is

_peek

_method

_chunkReader

_chunkInputStream

_replyFault

_sbuf

_isLastChunk

_chunkLength

Constructor Detail

HessianInput

HessianInput

Method Detail

setSerializerFactory

getSerializerFactory

init

getMethod

getReplyFault

readCall

skipOptionalCall

readMethod

startCall

completeCall

readReply

startReply

startReplyBody

prepareFault

completeReply

completeValueReply

readHeader

readNull

readBoolean

readShort

readInt

readLong

readFloat

readDouble

readUTCDate

readChar

readString

readString

readNode

readBytes

readByte

readBytes

readFault

readObject

readObject

readRemote

readRef

readListStart

readMapStart

isEnd

readEnd

readMapEnd

readListEnd

addRef

setRef

resetReferences

resolveRemote

readType

readLength

parseInt

parseLong

parseDouble

parseXML

parseChar

parseUTF8Char

parseByte