org.helenus.commons.lang3.SerializationUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helenus-commons Show documentation
JPA-like syntax for annotating POJO classes for persistence via Cassandra's Java driver - Common Utilities
There is a newer version: 3.0.4
/*
 * Copyright (C) 2015-2015 The Helenus Driver Project Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.helenus.commons.lang3;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Serializable;

import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;

import org.apache.commons.lang3.SerializationException;

/**
 * The SerializationUtils class defines helper methods for
 * serialization.
 *
 * @copyright 2015-2015 The Helenus Driver Project Authors
 *
 * @author  The Helenus Driver Project Authors
 * @version 1 - Jan 15, 2015 - paouelle - Creation
 *
 * @since 1.0
 */
public class SerializationUtils extends org.apache.commons.lang3.SerializationUtils {
  /**
   * Serializes and compresses a given object to 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.
   *
   * @author paouelle
   *
   * @param  obj the object to serialize and compress
   * @param  outputStream the stream to write to
   * @throws SerializationException (runtime) if the serialization fails
   * @throws NullPointerException if outputStream is null
   */
  public static void serializeAndCompress(Serializable obj, OutputStream outputStream) {
    org.apache.commons.lang3.Validate.notNull(outputStream, "invalid null outputStream");
    try {
      final GZIPOutputStream os = new GZIPOutputStream(outputStream);

      org.apache.commons.lang3.SerializationUtils.serialize(obj, os);
    } catch (IOException e) {
      throw new SerializationException(e);
    }
  }

  /**
   * Serializes and compresses a given object.
   *
   * @author paouelle
   *
   * @param  obj the object to serialize and compress
   * @return an array of bytes representing the compressed serialized form of
   *         the object
   * @throws SerializationException (runtime) if the serialization fails
   */
  public static byte[] serializeAndCompress(Serializable obj) {
    final ByteArrayOutputStream baos = new ByteArrayOutputStream(512);

    SerializationUtils.serializeAndCompress(obj, baos);
    return baos.toByteArray();
  }

  /**
   * Decompresses and 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.
   *
   * @author paouelle
   *
   * @param  inputStream the serialized object input stream
   * @return the corresponding object
   * @throws NullPointerException if outputStream is null
   * @throws SerializationException (runtime) if the serialization fails
   */
  public static Object decompressAndDeserialize(InputStream inputStream) {
    org.apache.commons.lang3.Validate.notNull(inputStream, "invalid null inputStream");
    try {
      final GZIPInputStream is = new GZIPInputStream(inputStream);

      return org.apache.commons.lang3.SerializationUtils.deserialize(is);
    } catch (IOException e) {
      throw new SerializationException(e);
    }
  }

  /**
   * Decompresses and deserializes the blob back into the original object.
   *
   * @author paouelle
   *
   * @param  data the blob to decompress and deserialize
   * @return the corresponding object
   * @throws SerializationException (runtime) if the serialization fails
   */
  public static Object decompressAndDeserialize(byte[] data) {
    return SerializationUtils.decompressAndDeserialize(
      new ByteArrayInputStream(data)
    );
  }
}