org.mule.util.SerializationUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-core
Mule server and core classes
There is a newer version: 3.9.0
/*
 * $Id: SerializationUtils.java 21551 2011-03-11 12:24:40Z tcarlson $
 * --------------------------------------------------------------------------------------
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.util;

import org.mule.api.MuleContext;
import org.mule.util.store.DeserializationPostInitialisable;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.ObjectInputStream;

import org.apache.commons.io.input.ClassLoaderObjectInputStream;
import org.apache.commons.lang.SerializationException;

public class SerializationUtils extends org.apache.commons.lang.SerializationUtils
{
    public static Object deserialize(InputStream inputStream, MuleContext muleContext)
    {
        if (muleContext == null)
        {
            throw new IllegalArgumentException("The MuleContext must not be null");
        }
        return deserialize(inputStream, muleContext.getExecutionClassLoader(), muleContext);
    }

    public static Object deserialize(byte[] objectData, MuleContext muleContext)
    {
        if (muleContext == null)
        {
            throw new IllegalArgumentException("The MuleContext must not be null");
        }
        return deserialize(objectData, muleContext.getExecutionClassLoader(), muleContext);        
    }
    
    /**
     * Deserializes an Object from the specified stream.
     * 
     * 
The stream will be closed once the object is written. This
     * avoids the need for a finally clause, and maybe also exception
     * handling, in the application code.
     * 
     * 
The stream passed in is not buffered internally within this method.
     * This is the responsibility of your application if desired.
     *
     * @param inputStream the serialized object input stream, must not be null
     * @param cl          classloader which can load custom classes from the stream
     * @return the deserialized object
     * @throws IllegalArgumentException if inputStream is null
     * @throws org.apache.commons.lang.SerializationException
     *                                  (runtime) if the serialization fails
     */
    private static Object deserialize(InputStream inputStream, ClassLoader cl, MuleContext muleContext)
    {
        if (inputStream == null)
        {
            throw new IllegalArgumentException("The InputStream must not be null");
        }
        if (cl == null)
        {
            throw new IllegalArgumentException("The ClassLoader must not be null");
        }
        ObjectInputStream in = null;
        try
        {
            // stream closed in the finally
            in = new ClassLoaderObjectInputStream(cl, inputStream);
            Object obj = in.readObject();
            if (obj instanceof DeserializationPostInitialisable)
            {
                DeserializationPostInitialisable.Implementation.init(obj, muleContext);
            }
            return obj;
        }
        catch (ClassNotFoundException ex)
        {
            throw new SerializationException(ex);
        }
        catch (IOException ex)
        {
            throw new SerializationException(ex);
        }
        catch (Exception ex)
        {
            throw new SerializationException(ex);
        }
        finally
        {
            try
            {
                if (in != null)
                {
                    in.close();
                }
            }
            catch (IOException ex)
            {
                // ignore close exception
            }
        }
    }

    /**
     * Deserializes a single Object from an array of bytes.
     *
     * @param objectData the serialized object, must not be null
     * @param cl         classloader which can load custom classes from the stream
     * @return the deserialized object
     * @throws IllegalArgumentException if objectData is null
     * @throws SerializationException   (runtime) if the serialization fails
     */
    private static Object deserialize(byte[] objectData, ClassLoader cl, MuleContext muleContext)
    {
        if (objectData == null)
        {
            throw new IllegalArgumentException("The byte[] must not be null");
        }
        ByteArrayInputStream bais = new ByteArrayInputStream(objectData);
        return deserialize(bais, cl, muleContext);
    }
    
    /**
     * @deprecated Call deserialize(InputStream inputStream, MuleContext muleContext) instead
     */
    public static Object deserialize(InputStream inputStream, ClassLoader cl)
    {
        return deserialize(inputStream, cl, null);
    }
    
    /**
     * @deprecated Call deserialize(byte[] objectData, MuleContext muleContext) instead
     */
    public static Object deserialize(byte[] objectData, ClassLoader cl)
    {
        return deserialize(objectData, cl, null);
    }    
}