001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2006-2008 Sun Microsystems, Inc.
025 *      Portions Copyright 2014-2015 ForgeRock AS
026 */
027package org.opends.server.loggers;
028import org.forgerock.i18n.LocalizableMessage;
029
030
031import org.opends.server.admin.std.server.SizeLimitLogRotationPolicyCfg;
032import org.opends.server.admin.server.ConfigurationChangeListener;
033import org.opends.server.types.InitializationException;
034import org.forgerock.opendj.config.server.ConfigChangeResult;
035import org.forgerock.opendj.config.server.ConfigException;
036
037import java.util.List;
038
039/**
040 * This class implements a rotation policy based on the size of the file.
041 */
042public class SizeBasedRotationPolicy implements
043    RotationPolicy<SizeLimitLogRotationPolicyCfg>,
044    ConfigurationChangeListener<SizeLimitLogRotationPolicyCfg>
045{
046  private long sizeLimit;
047
048  SizeLimitLogRotationPolicyCfg currentConfig;
049
050  /** {@inheritDoc} */
051  public void initializeLogRotationPolicy(SizeLimitLogRotationPolicyCfg config)
052      throws ConfigException, InitializationException
053  {
054    sizeLimit = config.getFileSizeLimit();
055
056    config.addSizeLimitChangeListener(this);
057    currentConfig = config;
058  }
059
060  /** {@inheritDoc} */
061  public boolean isConfigurationChangeAcceptable(
062      SizeLimitLogRotationPolicyCfg config, List<LocalizableMessage> unacceptableReasons)
063  {
064    // Changes should always be OK
065    return true;
066  }
067
068  /** {@inheritDoc} */
069  public ConfigChangeResult applyConfigurationChange(
070      SizeLimitLogRotationPolicyCfg config)
071  {
072    sizeLimit = config.getFileSizeLimit();
073    currentConfig = config;
074
075    return new ConfigChangeResult();
076  }
077
078  /**
079   * This method indicates if the log file should be
080   * rotated or not.
081   *
082   * @param writer The multi file text writer writing the log file.
083   * @return true if the file needs to be rotated, false otherwise.
084  */
085  public boolean rotateFile(RotatableLogFile writer)
086  {
087    long fileSize = writer.getBytesWritten();
088    return fileSize >= sizeLimit;
089  }
090
091}