server/loggers/MeteredStream.java

	MeteredStream.java revision 8fdf1768757fba933e7ce63ac6381eacec41f0c6
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2006-2008 Sun Microsystems, Inc.
 *      Portions Copyright 2014-2015 ForgeRock AS
 */
package org.opends.server.loggers;

import java.io.IOException;
import java.io.OutputStream;

/**
 * A metered stream is a subclass of OutputStream that
 *  (a) forwards all its output to a target stream
 *  (b) keeps track of how many bytes have been written.
 */
public final class MeteredStream extends OutputStream
{
  OutputStream out;
  volatile long written;

  /**
   * Create the stream wrapped around the specified output
   * stream.
   *
   * @param out     The target output stream to keep track of.
   * @param written The number of bytes written to the stream.
   */
  public MeteredStream(OutputStream out, long written)
  {
    this.out = out;
    this.written = written;
  }

  /**
   * Write the specified byte to the stream.
   *
   * @param b The value to be written to the stream.
   *
   * @exception IOException if the write failed.
   */
  public void write(int b) throws IOException
  {
    out.write(b);
    written++;
  }

  /**
   * Write the specified buffer to the stream.
   *
   * @param buff The value to be written to the stream.
   *
   * @exception IOException if the write failed.
   */
  public void write(byte buff[]) throws IOException
  {
    out.write(buff);
    written += buff.length;
  }

  /**
   * Write the specified buffer to the stream.
   *
   * @param buff The value to be written to the stream.
   * @param off  The offset to write from.
   * @param len  The length of the buffer to write.
   *
   * @exception IOException if the write failed.
   */
  public void write(byte buff[], int off, int len) throws IOException
  {
    out.write(buff,off,len);
    written += len;
  }

  /**
   * Flush the output stream which flushes the target output stream.
   *
   * @exception IOException if the flush failed.
   */
  public void flush() throws IOException
  {
    out.flush();
  }

  /**
   * Close the output stream which closes the target output stream.
   *
   * @exception IOException if the close failed.
   */
  public void close() throws IOException
  {
    out.close();
  }

  /**
   * Returns the number of bytes written in this stream.
   *
   * @return the number of bytes
   */
  public long getBytesWritten()
  {
    return written;
  }
}