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.retention;
017
018import java.io.File;
019import java.util.List;
020
021/**
022 * An interface to declare the names of audit log files.
023 */
024public interface FileNamingPolicy {
025    /**
026     * Initializes the policy and returns the current name to use.
027     *
028     * @return Not-null, The initial file.
029     */
030    File getInitialName();
031
032    /**
033     * Gets the next name to use.
034     *
035     * @return Not-null, The next file.
036     */
037    File getNextName();
038
039    /**
040     * Lists all the archived files.
041     * @return Not-null, All the archived files.
042     */
043    List<File> listFiles();
044}