com.caucho.hessian.io

Class HessianOutput

java.lang.Object

com.caucho.hessian.io.AbstractHessianOutput

com.caucho.hessian.io.HessianOutput

public class HessianOutput
extends AbstractHessianOutput

Output stream for Hessian requests, compatible with microedition Java. It only uses classes and types available in JDK.

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
 HessianOutput out = new HessianOutput(os);
 String value;

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

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	os

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

_serializerFactory

Constructor Summary

Constructors

Constructor and Description
HessianOutput() Creates an uninitialized Hessian output stream.
HessianOutput(OutputStream os) Creates a new Hessian output stream, initialized with an underlying output stream.

Method Summary

Methods

Modifier and Type	Method and 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	completeReply() Completes reading the reply
void	flush()
int	getRef(Object obj)
void	init(OutputStream os) Initializes the output
void	printLenString(String v) Prints a string to the stream, encoded as UTF-8 with preceeding length
void	printString(char[] v, int offset, 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 offset, 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	resetReferences() Resets the references for streaming.
void	setVersion(int version) Sets the client's version.
void	startCall() Writes the call tag.
void	startCall(String method, int length) Starts the method call.
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	writeDouble(double value) Writes a double value to the stream.
void	writeFault(String code, String message, Object detail) Writes a fault.
void	writeHeader(String name) Writes a header name.
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.
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.
void	writePlaceholder() Writes a placeholder.
void	writeRef(int value) Writes a reference.
void	writeRemote(String type, String url) Writes a remote object reference to the stream.
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.

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

findSerializerFactory, getSerializerFactory, setSerializerFactory, writeByteStream, writeClassFieldLength, writeObjectBegin, writeObjectEnd, writeReply

Methods inherited from class java.lang.Object

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

Field Detail

os

protected OutputStream os

Constructor Detail

HessianOutput

public HessianOutput(OutputStream os)

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

Parameters:

os - the underlying output stream.

HessianOutput

public HessianOutput()

Creates an uninitialized Hessian output stream.

Method Detail

init

public void init(OutputStream os)

Initializes the output

Overrides:

init in class AbstractHessianOutput

setVersion

public void setVersion(int version)

Sets the client's version.

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 major minor
 m b16 b8 method-name
 

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 headers and the method tag.

 c major minor
 

Specified by:

startCall in class AbstractHessianOutput

Throws:

IOException

writeMethod

public void writeMethod(String method)
                 throws IOException

Writes the method tag.

 m b16 b8 method-name
 

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

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

writeHeader

public void writeHeader(String name)
                 throws IOException

Writes a header name. The header value must immediately follow.

 H b16 b8 foo value
 

Overrides:

writeHeader in class AbstractHessianOutput

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
 <string>code
 <string>the fault code

 <string>message
 <string>the fault mesage

 <string>detail
 mt\x00\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.

 V
 t b16 b8 type
 l b32 b24 b16 b8
 

Specified by:

writeListBegin in class AbstractHessianOutput

Throws:

IOException

writeListEnd

public void writeListEnd()
                  throws IOException

Writes the tail of the list to the stream.

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.

 Mt b16 b8 ( )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

writeRemote

public void writeRemote(String type,
               String url)
                 throws IOException

Writes a remote object reference to the stream. The type is the type of the remote interface.

 'r' 't' b16 b8 type url
 

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.

 T  b64 b56 b48 b40 b32 b24 b16 b8
 

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

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:

buffer - the char array value to write.

offset - the index of the chars to write.

length - the number of chars 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:

buffer - the byte array 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:

buffer - the byte array value to write.

offset - the index of the bytes to write.

length - the number of bytes 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

Parameters:

buffer - the byte array value to write.

offset - the index of the bytes to write.

length - the number of bytes to write.

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

Parameters:

buffer - the byte array value to write.

offset - the index of the bytes to write.

length - the number of bytes to write.

Throws:

IOException

writeRef

public void writeRef(int value)
              throws IOException

Writes a reference.

 R b32 b24 b16 b8
 

Specified by:

writeRef in class AbstractHessianOutput

Parameters:

value - the integer value to write.

Throws:

IOException

writePlaceholder

public void writePlaceholder()
                      throws IOException

Writes a placeholder.

 P
 

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

Parameters:

obj - an object.

Returns:

its reference id.

resetReferences

public void resetReferences()

Resets the references for streaming.

Overrides:

resetReferences in class AbstractHessianOutput

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

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 offset,
               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 offset,
               int length)
                 throws IOException

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

Parameters:

v - the string to print.

Throws:

IOException

flush

public void flush()
           throws IOException

Overrides:

flush in class AbstractHessianOutput

Throws:

IOException

close

public void close()
           throws IOException

Overrides:

close in class AbstractHessianOutput

Throws:

IOException