1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.appender.rolling.action;
18
19 import java.io.IOException;
20
21
22 /**
23 * The Action interface should be implemented by any class that performs
24 * file system actions for RollingFileAppenders after the close of
25 * the active log file.
26 */
27 public interface Action extends Runnable {
28 /**
29 * Perform an action.
30 *
31 * @return true if action was successful. A return value of false will cause
32 * the rollover to be aborted if possible.
33 * @throws IOException if IO error, a thrown exception will cause the rollover
34 * to be aborted if possible.
35 */
36 boolean execute() throws IOException;
37
38 /**
39 * Cancels the action if not already initialized or waits till completion.
40 */
41 void close();
42
43 /**
44 * Determines if action has been completed.
45 *
46 * @return true if action is complete.
47 */
48 boolean isComplete();
49 }