Class MicroHessianOutput


  • public class MicroHessianOutput
    extends java.lang.Object
    Output stream for Hessian requests, compatible with microedition Java. It only uses classes and types available to J2ME. In particular, it does not have any support for the <double> type.

    MicroHessianOutput does not depend on any classes other than in J2ME, so it can be extracted independently into a smaller package.

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

     OutputStream os = ...; // from http connection
     MicroHessianOutput out = new MicroHessianOutput(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 Description
      protected java.io.OutputStream os  
    • Constructor Summary

      Constructors 
      Constructor Description
      MicroHessianOutput()
      Creates an uninitialized Hessian output stream.
      MicroHessianOutput​(java.io.OutputStream os)
      Creates a new Hessian output stream, initialized with an underlying output stream.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void completeCall()
      Writes the method call:
      void init​(java.io.OutputStream os)  
      void printLenString​(java.lang.String v)
      Prints a string to the stream, encoded as UTF-8 with preceeding length
      void printString​(java.lang.String v)
      Prints a string to the stream, encoded as UTF-8
      void printString​(java.lang.String v, int offset, int length)
      Prints a string to the stream, encoded as UTF-8
      void startCall​(java.lang.String method)
      Writes the method call:
      void writeBoolean​(boolean value)
      Writes a boolean value 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 writeCustomObject​(java.lang.Object object)
      Applications which override this can do custom serialization.
      void writeInt​(int value)
      Writes an integer value to the stream.
      void writeListBegin​(int length, java.lang.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​(java.lang.String type)
      Writes the map header to the stream.
      void writeMapEnd()
      Writes the tail of the map to the stream.
      void writeNull()
      Writes a null value to the stream.
      void writeObject​(java.lang.Object object)
      Writes a generic object to the output stream.
      void writeRef​(int value)
      Writes a reference.
      void writeRemote​(java.lang.String type, java.lang.String url)
      Writes a remote object reference to the stream.
      void writeString​(java.lang.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 java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • os

        protected java.io.OutputStream os
    • Constructor Detail

      • MicroHessianOutput

        public MicroHessianOutput​(java.io.OutputStream os)
        Creates a new Hessian output stream, initialized with an underlying output stream.
        Parameters:
        os - the underlying output stream.
      • MicroHessianOutput

        public MicroHessianOutput()
        Creates an uninitialized Hessian output stream.
    • Method Detail

      • init

        public void init​(java.io.OutputStream os)
      • startCall

        public void startCall​(java.lang.String method)
                       throws java.io.IOException
        Writes the method call:
         c major minor
         m b16 b8 method-namek
         
        Parameters:
        method - the method name to call.
        Throws:
        java.io.IOException
      • completeCall

        public void completeCall()
                          throws java.io.IOException
        Writes the method call:
         z
         
        Throws:
        java.io.IOException
      • writeBoolean

        public void writeBoolean​(boolean value)
                          throws java.io.IOException
        Writes a boolean value to the stream. The boolean will be written with the following syntax:
         T
         F
         
        Parameters:
        value - the boolean value to write.
        Throws:
        java.io.IOException
      • writeInt

        public void writeInt​(int value)
                      throws java.io.IOException
        Writes an integer value to the stream. The integer will be written with the following syntax:
         I b32 b24 b16 b8
         
        Parameters:
        value - the integer value to write.
        Throws:
        java.io.IOException
      • writeLong

        public void writeLong​(long value)
                       throws java.io.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
         
        Parameters:
        value - the long value to write.
        Throws:
        java.io.IOException
      • writeUTCDate

        public void writeUTCDate​(long time)
                          throws java.io.IOException
        Writes a date to the stream.
         T  b64 b56 b48 b40 b32 b24 b16 b8
         
        Parameters:
        time - the date in milliseconds from the epoch in UTC
        Throws:
        java.io.IOException
      • writeNull

        public void writeNull()
                       throws java.io.IOException
        Writes a null value to the stream. The null will be written with the following syntax
         N
         
        Parameters:
        value - the string value to write.
        Throws:
        java.io.IOException
      • writeString

        public void writeString​(java.lang.String value)
                         throws java.io.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
         
        Parameters:
        value - the string value to write.
        Throws:
        java.io.IOException
      • writeBytes

        public void writeBytes​(byte[] buffer)
                        throws java.io.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
         
        Parameters:
        value - the string value to write.
        Throws:
        java.io.IOException
      • writeBytes

        public void writeBytes​(byte[] buffer,
                               int offset,
                               int length)
                        throws java.io.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
         
        Parameters:
        value - the string value to write.
        Throws:
        java.io.IOException
      • writeRef

        public void writeRef​(int value)
                      throws java.io.IOException
        Writes a reference.
         R b32 b24 b16 b8
         
        Parameters:
        value - the integer value to write.
        Throws:
        java.io.IOException
      • writeObject

        public void writeObject​(java.lang.Object object)
                         throws java.io.IOException
        Writes a generic object to the output stream.
        Throws:
        java.io.IOException
      • writeCustomObject

        public void writeCustomObject​(java.lang.Object object)
                               throws java.io.IOException
        Applications which override this can do custom serialization.
        Parameters:
        object - the object to write.
        Throws:
        java.io.IOException
      • writeListBegin

        public void writeListBegin​(int length,
                                   java.lang.String type)
                            throws java.io.IOException
        Writes the list header to the stream. List writers will call writeListBegin followed by the list contents and then call writeListEnd.
         <list>
           <type>java.util.ArrayList</type>
           <length>3</length>
           <int>1</int>
           <int>2</int>
           <int>3</int>
         </list>
         
        Throws:
        java.io.IOException
      • writeListEnd

        public void writeListEnd()
                          throws java.io.IOException
        Writes the tail of the list to the stream.
        Throws:
        java.io.IOException
      • writeMapBegin

        public void writeMapBegin​(java.lang.String type)
                           throws java.io.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 type ( )z
         
        Throws:
        java.io.IOException
      • writeMapEnd

        public void writeMapEnd()
                         throws java.io.IOException
        Writes the tail of the map to the stream.
        Throws:
        java.io.IOException
      • writeRemote

        public void writeRemote​(java.lang.String type,
                                java.lang.String url)
                         throws java.io.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:
        java.io.IOException
      • printLenString

        public void printLenString​(java.lang.String v)
                            throws java.io.IOException
        Prints a string to the stream, encoded as UTF-8 with preceeding length
        Parameters:
        v - the string to print.
        Throws:
        java.io.IOException
      • printString

        public void printString​(java.lang.String v)
                         throws java.io.IOException
        Prints a string to the stream, encoded as UTF-8
        Parameters:
        v - the string to print.
        Throws:
        java.io.IOException
      • printString

        public void printString​(java.lang.String v,
                                int offset,
                                int length)
                         throws java.io.IOException
        Prints a string to the stream, encoded as UTF-8
        Parameters:
        v - the string to print.
        Throws:
        java.io.IOException