java.lang.Object

com.caucho.hessian.io.AbstractHessianOutput

com.caucho.hessian.io.Hessian2Output

All Implemented Interfaces:: Hessian2Constants

Direct Known Subclasses:: HessianSerializerOutput

public class Hessian2Output extends AbstractHessianOutput implements Hessian2Constants

Output stream for Hessian 2 requests.

Since HessianOutput does not depend on any classes other than in the JDK, it can be extracted independently into a smaller package.

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

 OutputStream os = ...; // from http connection
 Hessian2Output out = new Hessian2Output(os);
 String value;

 out.startCall("hello", 1); // start hello call
 out.writeString("arg1");   // write a string argument
 out.completeCall();        // complete the call

Field Summary

Fields

Modifier and Type

Field

Description

protected OutputStream

_os

static final int

SIZE

Fields inherited from class com.caucho.hessian.io.AbstractHessianOutput
_serializerFactory

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

Description

Hessian2Output()

Creates a new Hessian output stream, initialized with an underlying output stream.

Hessian2Output(OutputStream os)

Creates a new Hessian output stream, initialized with an underlying output stream.
Method Summary

Modifier and Type

Method

Description

boolean

addRef(Object object)

If the object has already been written, just write its ref.

void

call(String method, Object[] args)

Writes a complete method call.

void

close()

void

completeCall()

Completes.

void

completeEnvelope()

Completes an envelope.

void

completeMessage()

Completes reading the message

void

completeReply()

Completes reading the reply

void

endPacket()

final void

flush()

final void

flushBuffer()

void

free()

OutputStream

getBytesOutputStream()

Returns an output stream to write binary data.

int

getRef(Object obj)

void

init(OutputStream os)

Initialize the output with a new underlying stream.

void

initPacket(OutputStream os)

boolean

isCloseStreamOnClose()

void

printLenString(String v)

Prints a string to the stream, encoded as UTF-8 with preceeding length

void

printString(char[] v, int strOffset, int length)

Prints a string to the stream, encoded as UTF-8

void

printString(String v)

Prints a string to the stream, encoded as UTF-8

void

printString(String v, int strOffset, int length)

Prints a string to the stream, encoded as UTF-8

boolean

removeRef(Object obj)

Removes a reference.

boolean

replaceRef(Object oldRef, Object newRef)

Replaces a reference from one object to another.

void

reset()

Resets all counters and references

void

resetReferences()

Resets the references for streaming.

void

setCloseStreamOnClose(boolean isClose)

boolean

setUnshared(boolean isUnshared)

Sets hessian to be "unshared", meaning it will not detect duplicate or circular references.

void

startCall()

Writes the call tag.

void

startCall(String method, int length)

Starts the method call.

void

startEnvelope(String method)

Starts an envelope.

void

startMessage()

Starts a packet

void

startPacket()

Starts a streaming packet

void

startReply()

Starts the reply

void

writeBoolean(boolean value)

Writes a boolean value to the stream.

void

writeByteBufferEnd(byte[] buffer, int offset, int length)

Writes a byte buffer to the stream.

void

writeByteBufferPart(byte[] buffer, int offset, int length)

Writes a byte buffer to the stream.

void

writeByteBufferStart()

Writes a byte buffer to the stream.

void

writeBytes(byte[] buffer)

Writes a byte array to the stream.

void

writeBytes(byte[] buffer, int offset, int length)

Writes a byte array to the stream.

void

writeByteStream(InputStream is)

Writes a full output stream.

void

writeClassFieldLength(int len)

Writes the tail of the class definition to the stream.

void

writeDouble(double value)

Writes a double value to the stream.

void

writeFault(String code, String message, Object detail)

Writes a fault.

void

writeInt(int value)

Writes an integer value to the stream.

boolean

writeListBegin(int length, String type)

Writes the list header to the stream.

void

writeListEnd()

Writes the tail of the list to the stream for a variable-length list.

void

writeLong(long value)

Writes a long value to the stream.

void

writeMapBegin(String type)

Writes the map header to the stream.

void

writeMapEnd()

Writes the tail of the map to the stream.

void

writeMethod(String method)

Writes the method tag.

void

writeNull()

Writes a null value to the stream.

void

writeObject(Object object)

Writes any object to the output stream.

int

writeObjectBegin(String type)

Writes the object definition
void writeObjectEnd() Writes the tail of the object definition to the stream. protected void writeRef(int value) Writes a reference. void writeStreamingObject(Object obj) Starts the streaming message void writeString(char[] buffer, int offset, int length) Writes a string value to the stream using UTF-8 encoding. void writeString(String value) Writes a string value to the stream using UTF-8 encoding. void writeUTCDate(long time) Writes a date to the stream. void writeVersion()
Methods inherited from class com.caucho.hessian.io.AbstractHessianOutput findSerializerFactory, getSerializerFactory, setSerializerFactory, writeHeader, writeReply Methods inherited from class java.lang.Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait







Field Details



SIZE
public static final int SIZE

See Also:


Constant Field Values







_os
protected OutputStream _os








Constructor Details



Hessian2Output
public Hessian2Output()
Creates a new Hessian output stream, initialized with an
 underlying output stream.

Parameters:
os - the underlying output stream.





Hessian2Output
public Hessian2Output(OutputStream os)
Creates a new Hessian output stream, initialized with an
 underlying output stream.

Parameters:
os - the underlying output stream.









Method Details



init
public void init(OutputStream os)
Description copied from class: AbstractHessianOutput
Initialize the output with a new underlying stream.

Overrides:
init in class AbstractHessianOutput





initPacket
public void initPacket(OutputStream os)




setCloseStreamOnClose
public void setCloseStreamOnClose(boolean isClose)




isCloseStreamOnClose
public boolean isCloseStreamOnClose()




setUnshared
public boolean setUnshared(boolean isUnshared)
Sets hessian to be "unshared", meaning it will not detect 
 duplicate or circular references.

Overrides:
setUnshared in class AbstractHessianOutput





call
public void call(String method,
 Object[] args)
          throws IOException
Writes a complete method call.

Overrides:
call in class AbstractHessianOutput
Throws:
IOException





startCall
public void startCall(String method,
 int length)
               throws IOException
Starts the method call.  Clients would use startCall
 instead of call if they wanted finer control over
 writing the arguments, or needed to write headers.

  C
 string # method name
 int    # arg count
 

Specified by:
startCall in class AbstractHessianOutput
Parameters:
method - the method name to call.
Throws:
IOException





startCall
public void startCall()
               throws IOException
Writes the call tag.  This would be followed by the
 method and the arguments

  C
 

Specified by:
startCall in class AbstractHessianOutput
Parameters:
method - the method name to call.
Throws:
IOException





startEnvelope
public void startEnvelope(String method)
                   throws IOException
Starts an envelope.

  E major minor
 m b16 b8 method-name
 

Parameters:
method - the method name to call.
Throws:
IOException





completeEnvelope
public void completeEnvelope()
                      throws IOException
Completes an envelope.

 A successful completion will have a single value:

 
 Z
 

Throws:
IOException





writeMethod
public void writeMethod(String method)
                 throws IOException
Writes the method tag.

  string
 

Specified by:
writeMethod in class AbstractHessianOutput
Parameters:
method - the method name to call.
Throws:
IOException





completeCall
public void completeCall()
                  throws IOException
Completes.

  z
 

Specified by:
completeCall in class AbstractHessianOutput
Throws:
IOException





startReply
public void startReply()
                throws IOException
Starts the reply

 A successful completion will have a single value:

 
 R
 

Overrides:
startReply in class AbstractHessianOutput
Throws:
IOException





writeVersion
public void writeVersion()
                  throws IOException

Throws:
IOException





completeReply
public void completeReply()
                   throws IOException
Completes reading the reply

 A successful completion will have a single value:

 
 z
 

Overrides:
completeReply in class AbstractHessianOutput
Throws:
IOException





startMessage
public void startMessage()
                  throws IOException
Starts a packet

 A message contains several objects encapsulated by a length

  p x02 x00
 

Throws:
IOException





completeMessage
public void completeMessage()
                     throws IOException
Completes reading the message

 A successful completion will have a single value:

 
 z
 

Throws:
IOException





writeFault
public void writeFault(String code,
 String message,
 Object detail)
                throws IOException
Writes a fault.  The fault will be written
 as a descriptive string followed by an object:

  F map
 

  F H
 \x04code
 \x10the fault code

 \x07message
 \x11the fault message

 \x06detail
 M\xnnjavax.ejb.FinderException
     ...
 Z
 Z
 

Overrides:
writeFault in class AbstractHessianOutput
Parameters:
code - the fault code, a three digit
Throws:
IOException





writeObject
public void writeObject(Object object)
                 throws IOException
Writes any object to the output stream.

Specified by:
writeObject in class AbstractHessianOutput
Throws:
IOException





writeListBegin
public boolean writeListBegin(int length,
 String type)
                       throws IOException
Writes the list header to the stream.  List writers will call
 writeListBegin followed by the list contents and then
 call writeListEnd.

  list ::= V type value* Z
      ::= v type int value*
 

Specified by:
writeListBegin in class AbstractHessianOutput
Returns:
true for variable lists, false for fixed lists
Throws:
IOException





writeListEnd
public void writeListEnd()
                  throws IOException
Writes the tail of the list to the stream for a variable-length list.

Specified by:
writeListEnd in class AbstractHessianOutput
Throws:
IOException





writeMapBegin
public void writeMapBegin(String type)
                   throws IOException
Writes the map header to the stream.  Map writers will call
 writeMapBegin followed by the map contents and then
 call writeMapEnd.

  map ::= M type ( )* Z
     ::= H ( )* Z
 

Specified by:
writeMapBegin in class AbstractHessianOutput
Throws:
IOException





writeMapEnd
public void writeMapEnd()
                 throws IOException
Writes the tail of the map to the stream.

Specified by:
writeMapEnd in class AbstractHessianOutput
Throws:
IOException





writeObjectBegin
public int writeObjectBegin(String type)
                     throws IOException
Writes the object definition

  C <string> <int> <string>*
 

Overrides:
writeObjectBegin in class AbstractHessianOutput
Returns:
true if the object has already been defined.
Throws:
IOException





writeClassFieldLength
public void writeClassFieldLength(int len)
                           throws IOException
Writes the tail of the class definition to the stream.

Overrides:
writeClassFieldLength in class AbstractHessianOutput
Throws:
IOException





writeObjectEnd
public void writeObjectEnd()
                    throws IOException
Writes the tail of the object definition to the stream.

Overrides:
writeObjectEnd in class AbstractHessianOutput
Throws:
IOException





writeBoolean
public void writeBoolean(boolean value)
                  throws IOException
Writes a boolean value to the stream.  The boolean will be written
 with the following syntax:

  T
 F
 

Specified by:
writeBoolean in class AbstractHessianOutput
Parameters:
value - the boolean value to write.
Throws:
IOException





writeInt
public void writeInt(int value)
              throws IOException
Writes an integer value to the stream.  The integer will be written
 with the following syntax:

  I b32 b24 b16 b8
 

Specified by:
writeInt in class AbstractHessianOutput
Parameters:
value - the integer value to write.
Throws:
IOException





writeLong
public void writeLong(long value)
               throws IOException
Writes a long value to the stream.  The long will be written
 with the following syntax:

  L b64 b56 b48 b40 b32 b24 b16 b8
 

Specified by:
writeLong in class AbstractHessianOutput
Parameters:
value - the long value to write.
Throws:
IOException





writeDouble
public void writeDouble(double value)
                 throws IOException
Writes a double value to the stream.  The double will be written
 with the following syntax:

  D b64 b56 b48 b40 b32 b24 b16 b8
 

Specified by:
writeDouble in class AbstractHessianOutput
Parameters:
value - the double value to write.
Throws:
IOException





writeUTCDate
public void writeUTCDate(long time)
                  throws IOException
Writes a date to the stream.

  date ::= d   b7 b6 b5 b4 b3 b2 b1 b0
      ::= x65 b3 b2 b1 b0
 

Specified by:
writeUTCDate in class AbstractHessianOutput
Parameters:
time - the date in milliseconds from the epoch in UTC
Throws:
IOException





writeNull
public void writeNull()
               throws IOException
Writes a null value to the stream.
 The null will be written with the following syntax

  N
 

Specified by:
writeNull in class AbstractHessianOutput
Parameters:
value - the string value to write.
Throws:
IOException





writeString
public void writeString(String value)
                 throws IOException
Writes a string value to the stream using UTF-8 encoding.
 The string will be written with the following syntax:

  S b16 b8 string-value
 

 If the value is null, it will be written as

  N
 

Specified by:
writeString in class AbstractHessianOutput
Parameters:
value - the string value to write.
Throws:
IOException





writeString
public void writeString(char[] buffer,
 int offset,
 int length)
                 throws IOException
Writes a string value to the stream using UTF-8 encoding.
 The string will be written with the following syntax:

  S b16 b8 string-value
 

 If the value is null, it will be written as

  N
 

Specified by:
writeString in class AbstractHessianOutput
Parameters:
value - the string value to write.
Throws:
IOException





writeBytes
public void writeBytes(byte[] buffer)
                throws IOException
Writes a byte array to the stream.
 The array will be written with the following syntax:

  B b16 b18 bytes
 

 If the value is null, it will be written as

  N
 

Specified by:
writeBytes in class AbstractHessianOutput
Parameters:
value - the string value to write.
Throws:
IOException





writeBytes
public void writeBytes(byte[] buffer,
 int offset,
 int length)
                throws IOException
Writes a byte array to the stream.
 The array will be written with the following syntax:

  B b16 b18 bytes
 

 If the value is null, it will be written as

  N
 

Specified by:
writeBytes in class AbstractHessianOutput
Parameters:
value - the string value to write.
Throws:
IOException





writeByteBufferStart
public void writeByteBufferStart()
                          throws IOException
Writes a byte buffer to the stream.

  

Specified by:
writeByteBufferStart in class AbstractHessianOutput
Throws:
IOException





writeByteBufferPart
public void writeByteBufferPart(byte[] buffer,
 int offset,
 int length)
                         throws IOException
Writes a byte buffer to the stream.

  b b16 b18 bytes
 

Specified by:
writeByteBufferPart in class AbstractHessianOutput
Throws:
IOException





writeByteBufferEnd
public void writeByteBufferEnd(byte[] buffer,
 int offset,
 int length)
                        throws IOException
Writes a byte buffer to the stream.

  b b16 b18 bytes
 

Specified by:
writeByteBufferEnd in class AbstractHessianOutput
Throws:
IOException





getBytesOutputStream
public OutputStream getBytesOutputStream()
                                  throws IOException
Returns an output stream to write binary data.

Throws:
IOException





writeByteStream
public void writeByteStream(InputStream is)
                     throws IOException
Writes a full output stream.

Overrides:
writeByteStream in class AbstractHessianOutput
Throws:
IOException





writeRef
protected void writeRef(int value)
                 throws IOException
Writes a reference.

  x51 <int>
 

Specified by:
writeRef in class AbstractHessianOutput
Parameters:
value - the integer value to write.
Throws:
IOException





addRef
public boolean addRef(Object object)
               throws IOException
If the object has already been written, just write its ref.

Specified by:
addRef in class AbstractHessianOutput
Parameters:
object - the object to add as a reference.
Returns:
true if we're writing a ref.
Throws:
IOException





getRef
public int getRef(Object obj)

Specified by:
getRef in class AbstractHessianOutput
Returns:





removeRef
public boolean removeRef(Object obj)
                  throws IOException
Removes a reference.

Overrides:
removeRef in class AbstractHessianOutput
Throws:
IOException





replaceRef
public boolean replaceRef(Object oldRef,
 Object newRef)
                   throws IOException
Replaces a reference from one object to another.

Specified by:
replaceRef in class AbstractHessianOutput
Throws:
IOException





writeStreamingObject
public void writeStreamingObject(Object obj)
                          throws IOException
Starts the streaming message

 A streaming message starts with 'P'

  P x02 x00
 

Throws:
IOException





startPacket
public void startPacket()
                 throws IOException
Starts a streaming packet

 A streaming contains a set of chunks, ending with a zero chunk.
 Each chunk is a length followed by data where the length is
 encoded by (b1xxxxxxxx)* b0xxxxxxxx

Throws:
IOException





endPacket
public void endPacket()
               throws IOException

Throws:
IOException





printLenString
public void printLenString(String v)
                    throws IOException
Prints a string to the stream, encoded as UTF-8 with preceeding length

Parameters:
v - the string to print.
Throws:
IOException





printString
public void printString(String v)
                 throws IOException
Prints a string to the stream, encoded as UTF-8

Parameters:
v - the string to print.
Throws:
IOException





printString
public void printString(String v,
 int strOffset,
 int length)
                 throws IOException
Prints a string to the stream, encoded as UTF-8

Parameters:
v - the string to print.
Throws:
IOException





printString
public void printString(char[] v,
 int strOffset,
 int length)
                 throws IOException
Prints a string to the stream, encoded as UTF-8

Parameters:
v - the string to print.
Throws:
IOException





flush
public final void flush()
                 throws IOException

Overrides:
flush in class AbstractHessianOutput
Throws:
IOException





flushBuffer
public final void flushBuffer()
                       throws IOException

Throws:
IOException





close
public void close()
           throws IOException

Overrides:
close in class AbstractHessianOutput
Throws:
IOException





free
public void free()




resetReferences
public void resetReferences()
Resets the references for streaming.

Overrides:
resetReferences in class AbstractHessianOutput





reset
public void reset()
Resets all counters and references

Class Hessian2Output

Field Summary

Fields inherited from class com.caucho.hessian.io.AbstractHessianOutput

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Details

SIZE

_os

Constructor Details

Hessian2Output

Hessian2Output

Method Details

init

initPacket

setCloseStreamOnClose

isCloseStreamOnClose

setUnshared

call

startCall

startCall

startEnvelope

completeEnvelope

writeMethod

completeCall

startReply

writeVersion

completeReply

startMessage

completeMessage

writeFault

writeObject

writeListBegin

writeListEnd

writeMapBegin

writeMapEnd

writeObjectBegin

writeClassFieldLength

writeObjectEnd

writeBoolean

writeInt

writeLong

writeDouble

writeUTCDate

writeNull

writeString

writeString

writeBytes

writeBytes

writeByteBufferStart

writeByteBufferPart

writeByteBufferEnd

getBytesOutputStream

writeByteStream

writeRef

addRef

getRef

removeRef

replaceRef

writeStreamingObject

startPacket

endPacket

printLenString

printString

printString

printString

flush

flushBuffer

close

free

resetReferences

reset