Package org.infinispan.jboss.marshalling.commons

Class AbstractJBossMarshaller

java.lang.Object
org.infinispan.commons.marshall.AbstractMarshaller
org.infinispan.jboss.marshalling.commons.AbstractJBossMarshaller
All Implemented Interfaces:
Marshaller, StreamingMarshaller
Direct Known Subclasses:
GenericJBossMarshaller, JBossMarshaller
public abstract class AbstractJBossMarshaller extends AbstractMarshaller implements StreamingMarshaller
Common parent for both embedded and standalone JBoss Marshalling-based marshallers.
Since:
5.0
Author:
Galder Zamarreño, Sanne Grinovero, Dan Berindei

  • Field Details

    • log

      protected static final org.infinispan.commons.logging.Log log

    • factory

      protected static final JBossMarshallerFactory factory

    • DEF_INSTANCE_COUNT

      protected static final int DEF_INSTANCE_COUNT
      See Also:

    • DEF_CLASS_COUNT

      protected static final int DEF_CLASS_COUNT
      See Also:

    • baseCfg

      protected final org.jboss.marshalling.MarshallingConfiguration baseCfg

  • Constructor Details

    • AbstractJBossMarshaller

      public AbstractJBossMarshaller()

  • Method Details

    • objectToObjectStream

      public final void objectToObjectStream(Object obj, ObjectOutput out) throws IOException
      Description copied from interface: StreamingMarshaller
      Marshalls an object to a given ObjectOutput
      Specified by:
      objectToObjectStream in interface StreamingMarshaller
      Parameters:
      obj - object to marshall
      out - stream to marshall to
      Throws:
      IOException

    • objectToBuffer

      protected final ByteBuffer objectToBuffer(Object o, int estimatedSize) throws IOException
      Description copied from class: AbstractMarshaller
      This is a convenience method for converting an object into a ByteBuffer which takes an estimated size as parameter. A ByteBuffer allows direct access to the byte array with minimal array copying
      Specified by:
      objectToBuffer in class AbstractMarshaller
      Parameters:
      o - object to marshall
      estimatedSize - an estimate of how large the resulting byte array may be
      Throws:
      IOException

    • startObjectOutput

      public final ObjectOutput startObjectOutput(OutputStream os, boolean isReentrant, int estimatedSize) throws IOException
      Description copied from interface: StreamingMarshaller

      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 StreamingMarshaller 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 StreamingMarshaller 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 across. This enables storing as binary on the receiver side which is performance gain. The StreamingMarshaller 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.

      Specified by:
      startObjectOutput in interface StreamingMarshaller
      Parameters:
      os - output stream
      isReentrant - whether the call is reentrant or not.
      estimatedSize - estimated size in bytes of the output. Only meant as a possible performance optimization.
      Returns:
      ObjectOutput to write to
      Throws:
      IOException

    • finishObjectOutput

      public final void finishObjectOutput(ObjectOutput oo)
      Description copied from interface: StreamingMarshaller
      Finish using the given ObjectOutput. After opening a ObjectOutput and calling objectToObjectStream() multiple times, use this method to flush the data and close if necessary
      Specified by:
      finishObjectOutput in interface StreamingMarshaller
      Parameters:
      oo - data output that finished using

    • objectFromByteBuffer

      public final Object objectFromByteBuffer(byte[] buf, int offset, int length) throws IOException, ClassNotFoundException
      Description copied from interface: Marshaller
      Unmarshalls an object from a specific portion of a byte array.
      Specified by:
      objectFromByteBuffer in interface Marshaller
      Parameters:
      buf - byte array containing the binary representation of an object. Must not be null.
      offset - point in buffer to start reading
      length - number of bytes to consider
      Returns:
      an object
      Throws:
      IOException - if unmarshalling cannot complete due to some I/O error
      ClassNotFoundException - if the class of the object trying to unmarshall is unknown

    • startObjectInput

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

      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 StreamingMarshaller implementation could potentially use some mechanisms to speed up this startObjectInput call.

      Specified by:
      startObjectInput in interface StreamingMarshaller
      Parameters:
      is - input stream
      isReentrant - whether the call is reentrant or not.
      Returns:
      ObjectInput to read from
      Throws:
      IOException

    • objectFromObjectStream

      public final Object objectFromObjectStream(ObjectInput in) throws IOException, ClassNotFoundException
      Description copied from interface: StreamingMarshaller
      Unmarshalls an object from an ObjectInput
      Specified by:
      objectFromObjectStream in interface StreamingMarshaller
      Parameters:
      in - stream to unmarshall from
      Throws:
      IOException - if unmarshalling cannot complete due to some I/O error
      ClassNotFoundException - if the class of the object trying to unmarshall is unknown

    • finishObjectInput

      public final void finishObjectInput(ObjectInput oi)
      Description copied from interface: StreamingMarshaller
      Finish using the given ObjectInput. After opening a ObjectInput and calling objectFromObjectStream() multiple times, use this method to flush the data and close if necessary
      Specified by:
      finishObjectInput in interface StreamingMarshaller
      Parameters:
      oi - data input that finished using

    • isMarshallable

      public boolean isMarshallable(Object o) throws Exception
      Description copied from interface: Marshaller
      A method that checks whether the given object is marshallable as per the rules of this marshaller.
      Specified by:
      isMarshallable in interface Marshaller
      Parameters:
      o - object to verify whether it's marshallable or not
      Returns:
      true if the object is marshallable, otherwise false
      Throws:
      Exception - if while checking whether the object was serializable or not, an exception arose

    • start

      public void start()
      Description copied from interface: Marshaller
      Perform any initialization required before the marshaller is used.
      Specified by:
      start in interface Marshaller
      Specified by:
      start in interface StreamingMarshaller

    • stop

      public void stop()
      Description copied from interface: StreamingMarshaller
      Stop the marshaller. Implementations of this method should clear up any cached data, or close any resources while marshalling/unmarshalling that have not been already closed.
      Specified by:
      stop in interface Marshaller
      Specified by:
      stop in interface StreamingMarshaller

    • isMarshallableCandidate

      protected boolean isMarshallableCandidate(Object o)

    • mediaType

      public MediaType mediaType()
      Specified by:
      mediaType in interface Marshaller
      Returns:
      the MediaType associated with the content produced by the marshaller