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-2016 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 * @param context The rotation context. 027 * @throws IOException If the post action fails. 028 */ 029 void postRotationAction(RotationContext context) throws IOException; 030 031 /** 032 * Method to run an action just before file will be rotated. 033 * @param context The rotation context. 034 * @throws IOException If the pre action fails. 035 */ 036 void preRotationAction(RotationContext context) throws IOException; 037 038 /** 039 * {@link RotationHooks} that do nothing. 040 */ 041 class NoOpRotatationHooks implements RotationHooks { 042 043 @Override 044 public void postRotationAction(RotationContext context) throws IOException { 045 // do nothing 046 } 047 048 @Override 049 public void preRotationAction(RotationContext context) throws IOException { 050 // do nothing 051 } 052 } 053}