001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2015 ForgeRock AS.
015 */
016package org.forgerock.audit.retention;
017
018import java.io.IOException;
019
020public interface RetentionHooks {
021
022    /**
023     * Method to run an action just before the file is run through the {@link RetentionPolicy}'s.
024     * @throws IOException If the pre action fails.
025     */
026     void postRetentionAction() throws IOException;
027
028    /**
029     * {@link RetentionHooks} that do nothing.
030     */
031    class NullRetentionHooks implements RetentionHooks {
032
033        @Override
034        public void postRetentionAction() throws IOException {
035            // do nothing
036        }
037    }
038}