/*
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  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
 *
 *
 *      Portions Copyright 2006 Sun Microsystems, Inc.
 */
package org.opends.server.loggers;

import org.opends.server.types.DebugLogCategory;
import org.opends.server.types.DebugLogSeverity;

import static org.opends.server.loggers.Debug.*;

/**
 * This class implements a rotation policy based on the size of the
 * file.
 */
public class SizeBasedRotationPolicy implements RotationPolicy
{

  private static final String CLASS_NAME =
      "org.opends.server.loggers.SizeBasedRotationPolicy";

  private long sizeLimit;
  private DirectoryFileHandler fileHandler;

  /**
   * Create the size based policy.
   *
   * @param size    The size of the file when rotation takes place.
   */
  public SizeBasedRotationPolicy(long size)
  {
    assert debugConstructor(CLASS_NAME, String.valueOf(size));
    sizeLimit = size;
  }

  /**
   * Set the file handler instance.
   *
   * @param handler The file handler which manages the file to be rotated.
   */
  public void setFileHandler(DirectoryFileHandler handler)
  {
    this.fileHandler = handler;
  }

  /**
   * Get the maximum allowable file size.
   *
   * @return  The maximum allowable file size.
   */
  public long getMaxFileSize()
  {
    return sizeLimit;
  }

  /**
   * This method indicates if the log file should be
   * rotated or not.
   *
   * @return true if the file needs to be rotated, false otherwise.
  */
  public boolean rotateFile()
  {
    assert debugEnter(CLASS_NAME, "rotateFile");
    if(fileHandler.getFileSize() >= sizeLimit)
    {
      assert debugMessage(DebugLogCategory.CORE_SERVER,
                          DebugLogSeverity.INFO, CLASS_NAME, "rotateFile",
                          "File Length:" + fileHandler.getFileSize());
      return true;
    }
    return false;
  }

}