org.infinispan.marshall.jboss
Class JBossMarshaller

java.lang.Object
  extended by org.infinispan.marshall.AbstractMarshaller
      extended by org.infinispan.marshall.jboss.JBossMarshaller
All Implemented Interfaces:
Marshaller

public class JBossMarshaller
extends AbstractMarshaller

JBossMarshaller.

Since:
4.0
Author:
Galder ZamarreƱo

Constructor Summary
JBossMarshaller()
           
 
Method Summary
 void finishObjectInput(ObjectInput oi)
          Finish using the given ObjectInput.
 void finishObjectOutput(ObjectOutput oo)
          Finish using the given ObjectOutput.
 Object objectFromByteBuffer(byte[] buf)
           
 Object objectFromByteBuffer(byte[] buf, int offset, int length)
           
 Object objectFromObjectStream(ObjectInput in)
          Unmarshalls an object from an ObjectInput
 ByteBuffer objectToBuffer(Object o)
          A method that returns an instance of ByteBuffer, which allows direct access to the byte array with minimal array copying
 byte[] objectToByteBuffer(Object obj)
           
 void objectToObjectStream(Object obj, ObjectOutput out)
          Marshalls an object to a given ObjectOutput
 void start(ClassLoader defaultCl, RemoteCommandsFactory cmdFactory, Marshaller ispnMarshaller)
           
 ObjectInput startObjectInput(InputStream is, boolean isReentrant)
          Create and open a new ObjectInput for the given input stream.
 ObjectOutput startObjectOutput(OutputStream os, boolean isReentrant)
          Create and open an ObjectOutput instance for the given output stream.
 void stop()
           
 
Methods inherited from class org.infinispan.marshall.AbstractMarshaller
objectFromInputStream
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JBossMarshaller

public JBossMarshaller()
Method Detail

start

public void start(ClassLoader defaultCl,
                  RemoteCommandsFactory cmdFactory,
                  Marshaller ispnMarshaller)

stop

public void stop()

objectToByteBuffer

public byte[] objectToByteBuffer(Object obj)
                          throws IOException
Throws:
IOException

objectToBuffer

public ByteBuffer objectToBuffer(Object o)
                          throws IOException
Description copied from interface: Marshaller
A method that returns an instance of ByteBuffer, which allows direct access to the byte array with minimal array copying

Parameters:
o - object to marshall
Returns:
a ByteBuffer
Throws:
IOException

startObjectOutput

public ObjectOutput startObjectOutput(OutputStream os,
                                      boolean isReentrant)
                               throws IOException
Description copied from interface: Marshaller

Create and open an ObjectOutput instance for the given output stream. This method should be used for opening data outputs when multiple objectToObjectStream() calls will be made before the stream is closed by calling finishObjectOutput().

This method also takes a boolean that represents whether this particular call to startObjectOutput() is reentrant or not. A call to startObjectOutput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectOutput() first.

To potentially speed up calling startObjectOutput multiple times in a non-reentrant way, i.e. startObjectOutput/finishObjectOutput...startObjectOutput/finishObjectOutput...etc, which is is the most common case, the Marshaller implementation could potentially use some mechanisms to speed up this startObjectOutput call.

On the other hand, when a call is reentrant, i.e. startObjectOutput/startObjectOutput(reentrant)...finishObjectOutput/finishObjectOutput, the Marshaller implementation might treat it differently. An example of reentrancy would be marshalling of MarshalledValue. When sending or storing a MarshalledValue, a call to startObjectOutput() would occur so that the stream is open and following, a 2nd call could occur so that MarshalledValue's raw byte array version is calculated and sent accross. This enables lazy deserialization on the receiver side which is performance gain. The Marshaller implementation could decide that it needs a separate ObjectOutput or similar for the 2nd call since it's aim is only to get the raw byte array version and the close finish with it.

Parameters:
os - output stream
isReentrant - whether the call is reentrant or not.
Returns:
ObjectOutput to write to
Throws:
IOException

finishObjectOutput

public void finishObjectOutput(ObjectOutput oo)
Description copied from interface: Marshaller
Finish using the given ObjectOutput. After opening a ObjectOutput and calling objectToObjectStream() mutliple times, use this method to flush the data and close if necessary

Parameters:
oo - data output that finished using

objectToObjectStream

public void objectToObjectStream(Object obj,
                                 ObjectOutput out)
                          throws IOException
Description copied from interface: Marshaller
Marshalls an object to a given ObjectOutput

Parameters:
obj - object to marshall
out - stream to marshall to
Throws:
IOException

objectFromByteBuffer

public Object objectFromByteBuffer(byte[] buf)
                            throws IOException,
                                   ClassNotFoundException
Throws:
IOException
ClassNotFoundException

objectFromByteBuffer

public Object objectFromByteBuffer(byte[] buf,
                                   int offset,
                                   int length)
                            throws IOException,
                                   ClassNotFoundException
Throws:
IOException
ClassNotFoundException

startObjectInput

public ObjectInput startObjectInput(InputStream is,
                                    boolean isReentrant)
                             throws IOException
Description copied from interface: Marshaller

Create and open a new ObjectInput for the given input stream. This method should be used for opening data inputs when multiple objectFromObjectStream() calls will be made before the stream is closed.

This method also takes a boolean that represents whether this particular call to startObjectInput() is reentrant or not. A call to startObjectInput() should be marked reentrant whenever a 2nd or more calls to this method are made without having called finishObjectInput() first.

To potentially speed up calling startObjectInput multiple times in a non-reentrant way, i.e. startObjectInput/finishObjectInput...startObjectInput/finishObjectInput...etc, which is is the most common case, the Marshaller implementation could potentially use some mechanisms to speed up this startObjectInput call.

Parameters:
is - input stream
isReentrant - whether the call is reentrant or not.
Returns:
ObjectInput to read from
Throws:
IOException

finishObjectInput

public void finishObjectInput(ObjectInput oi)
Description copied from interface: Marshaller
Finish using the given ObjectInput. After opening a ObjectInput and calling objectFromObjectStream() mutliple times, use this method to flush the data and close if necessary

Parameters:
oi - data input that finished using

objectFromObjectStream

public Object objectFromObjectStream(ObjectInput in)
                              throws IOException,
                                     ClassNotFoundException
Description copied from interface: Marshaller
Unmarshalls an object from an ObjectInput

Parameters:
in - stream to unmarshall from
Throws:
IOException
ClassNotFoundException

Google Analytics

Copyright © 2010 JBoss, a division of Red Hat. All Rights Reserved.