com.caucho.vfs.StreamSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resin-kernel Show documentation
Kernel for Resin Java Application Server
The newest version!
/*
 * Copyright (c) 1998-2012 Caucho Technology -- all rights reserved
 *
 * This file is part of Resin(R) Open Source
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Resin Open Source is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Resin Open Source is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Resin Open Source; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 *
 * @author Scott Ferguson
 */

package com.caucho.vfs;

import java.io.IOException;
import java.io.InputStream;
import java.util.logging.Logger;

import com.caucho.util.L10N;

/**
 * Stream source for Hessian serialization of large data
 */
public class StreamSource
{
  private static final Logger log
    = Logger.getLogger(StreamSource.class.getName());
  
  private static final L10N L = new L10N(StreamSource.class);
  
  private TempOutputStream _out;
  private StreamSource _indirectSource;

  /**
   * Constructor for subclasses.
   */
  protected StreamSource()
  {
  }

  /**
   * Constructor for Hessian deserialization.
   */
  public StreamSource(TempOutputStream os)
  {
    _out = os;
  }

  /**
   * Constructor allowing for dynamic opening.
   */
  public StreamSource(StreamSource indirectSource)
  {
    _indirectSource = indirectSource;
  }

  /**
   * Returns an input stream, freeing the results
   */
  public InputStream getInputStream()
    throws IOException
  {
    if (_indirectSource != null)
      return _indirectSource.getInputStream();
    else if (_out != null)
      return _out.openInputStream();
    else {
      log.fine(L.l("{0}: no input stream is available", this));
      
      return null;
    }
  }

  /**
   * Returns an input stream, without freeing the results
   */
  public InputStream openInputStream()
    throws IOException
  {
    if (_indirectSource != null)
      return _indirectSource.openInputStream();
    else if (_out != null)
      return _out.openInputStreamNoFree();
    else {
      log.fine(L.l("{0}: no input stream is available", this));
      
      return null;
    }
  }

  /**
   * Close the stream.
   */
  public void close()
  {
    TempOutputStream out = _out;
    _out = null;
    
    StreamSource ss = _indirectSource;
    _indirectSource = null;

    if (out != null)
      out.destroy();
    
    if (ss != null)
      ss.close();
  }
  
  @Override
  public String toString()
  {
    return getClass().getSimpleName() + "[" + _out + "," + _indirectSource + "]";
  }
}