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.rotation;
017
018import java.io.IOException;
019
020/**
021 * Callback hooks to allow custom action to be taken before and after file rotation occurs.
022 */
023public interface RotationHooks {
024    /**
025     * Method to run an action just after file has been rotated.
026     * @throws IOException If the post action fails.
027     */
028    void postRotationAction(RotationContext context) throws IOException;
029
030    /**
031     * Method to run an action just before file will be rotated.
032     * @throws IOException If the pre action fails.
033     */
034    void preRotationAction(RotationContext context) throws IOException;
035
036    /**
037     * {@link RotationHooks} that do nothing.
038     */
039    class NoOpRotatationHooks implements RotationHooks {
040
041        @Override
042        public void postRotationAction(RotationContext context) throws IOException {
043            // do nothing
044        }
045
046        @Override
047        public void preRotationAction(RotationContext context) throws IOException {
048            // do nothing
049        }
050    }
051}