001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.appender.rolling.action;
018
019import java.io.IOException;
020
021
022/**
023 * The Action interface should be implemented by any class that performs
024 * file system actions for RollingFileAppenders after the close of
025 * the active log file.
026 */
027public interface Action extends Runnable {
028    /**
029     * Perform an action.
030     *
031     * @return true if action was successful.  A return value of false will cause
032     *         the rollover to be aborted if possible.
033     * @throws IOException if IO error, a thrown exception will cause the rollover
034     *                     to be aborted if possible.
035     */
036    boolean execute() throws IOException;
037
038    /**
039     * Cancels the action if not already initialized or waits till completion.
040     */
041    void close();
042
043    /**
044     * Determines if action has been completed.
045     *
046     * @return true if action is complete.
047     */
048    boolean isComplete();
049}