org.gridgain.grid.marshaller

Interface GridMarshaller

All Known Implementing Classes:

GridAbstractMarshaller, GridJdkMarshaller, GridOptimizedMarshaller

public interface GridMarshaller

GridMarshaller allows to marshal or unmarshal objects in grid. It provides serialization/deserialization mechanism for all instances that are sent across networks or are otherwise serialized.

Gridgain provides the following GridMarshaller implementations:

• GridOptimizedMarshaller - default
• GridJdkMarshaller

Below are examples of marshaller configuration, usage, and injection into tasks, jobs, and SPI's.

Java Example

GridMarshaller can be explicitely configured in code.

 GridJdkMarshaller marshaller = new GridJdkMarshaller();

 GridConfiguration cfg = new GridConfiguration();

 // Override marshaller.
 cfg.setMarshaller(marshaller);

 // Starts grid.
 G.start(cfg);
 

Spring Example

GridMarshaller can be configured from Spring XML configuration file:

 <bean id="grid.custom.cfg" class="org.gridgain.grid.GridConfiguration" singleton="true">
     ...
     <property name="marshaller">
         <bean class="org.gridgain.grid.marshaller.jdk.GridJdkMarshaller"/>
     </property>
     ...
 </bean>
 

For information about Spring framework visit www.springframework.org

Injection Example

GridMarshaller can be injected in users task, job or SPI as following:

 public class MyGridJob implements GridComputeJob {
     ...
     @GridMarshallerResource
     private GridMarshaller marshaller;

     public Serializable execute() {
         // Use marshaller to serialize/deserialize any object.
         ...
     }
 }
 

or

 public class MyGridJob implements GridComputeJob {
     ...
     private GridMarshaller marshaller;
     ...
     @GridMarshallerResource
     public void setMarshaller(GridMarshaller marshaller) {
         this.marshaller = marshaller;
     }
     ...
 }
 

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	marshal(Object obj) Marshals object to byte array.
void	marshal(Object obj, OutputStream out) Marshals object to the output stream.
<T> T	unmarshal(byte[] arr, ClassLoader clsLdr) Unmarshals object from byte array using given class loader.
<T> T	unmarshal(InputStream in, ClassLoader clsLdr) Unmarshals object from the output stream using given class loader.

Method Detail

marshal

void marshal(@Nullable
           Object obj,
           OutputStream out)
             throws GridException

Marshals object to the output stream. This method should not close given output stream.

Parameters:

obj - Object to marshal.

out - Output stream to marshal into.

Throws:

GridException - If marshalling failed.

marshal

byte[] marshal(@Nullable
             Object obj)
               throws GridException

Marshals object to byte array.

Parameters:

obj - Object to marshal.

Returns:

Byte array.

Throws:

GridException - If marshalling failed.

unmarshal

<T> T unmarshal(InputStream in,
              @Nullable
              ClassLoader clsLdr)
            throws GridException

Unmarshals object from the output stream using given class loader. This method should not close given input stream.

Type Parameters:

T - Type of unmarshalled object.

Parameters:

in - Input stream.

clsLdr - Class loader to use.

Returns:

Unmarshalled object.

Throws:

GridException - If unmarshalling failed.

unmarshal

<T> T unmarshal(byte[] arr,
              @Nullable
              ClassLoader clsLdr)
            throws GridException

Unmarshals object from byte array using given class loader.

Type Parameters:

T - Type of unmarshalled object.

Parameters:

arr - Byte array.

clsLdr - Class loader to use.

Returns:

Unmarshalled object.

Throws:

GridException - If unmarshalling failed.