ExpirationAction.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.nifi.provenance.expiration;

import java.io.File;
import java.io.IOException;

public interface ExpirationAction {

    /**
     * Performs some action against the given File and returns the new File that
     * contains the modified version
     *
     * @param expiredFile the file that was expired
     * @return the new file after the file has been renamed, or the expiredFile if the file was not renamed
     * @throws IOException if there was an IO problem
     */
    File execute(File expiredFile) throws IOException;

    boolean hasBeenPerformed(File expiredFile) throws IOException;
}