Package org.forgerock.audit.retention

Interface FileNamingPolicy

All Known Implementing Classes:
TimeStampFileNamingPolicy
public interface FileNamingPolicy
An interface to declare the names of audit log files.

  • Method Summary

    Modifier and Type
    Method
    Description
    File
    getInitialName()
    Initializes the policy and returns the current name to use.
    File
    getNextName()
    Gets the next name to use.
    List<File>
    listFiles()
    Lists all the archived files, from oldest to newest.

  • Method Details

    • getInitialName

      File getInitialName()
      Initializes the policy and returns the current name to use.
      Returns:
      Not-null, The initial file.

    • getNextName

      File getNextName()
      Gets the next name to use.
      Returns:
      Not-null, The next file.

    • listFiles

      List<File> listFiles()
      Lists all the archived files, from oldest to newest.
      Returns:
      Not-null, All the archived files.