/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2006-2008 Sun Microsystems, Inc.
 * Portions Copyright 2014-2015 ForgeRock AS.
 */
package org.opends.server.loggers;

import java.util.ArrayList;

/**
 * This interface describes the handler that is invoked when the logger
 * thread generates an alarm based on a rotation policy condition being met.
 */
interface LoggerAlarmHandler
{

  /**
   * Flush the underlying stream.
   */
  void flush();

  /**
   * Action to take when the logger thread generates an alarm based
   * on the rotation policy condition being met.
   */
  void rollover();


  /**
   * This method sets the actions that need to be executed after rotation.
   *
   * @param actions An array of actions that need to be executed on rotation.
   */
  void setPostRotationActions(ArrayList<ActionType> actions);

}