001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import org.opends.server.admin.server.ConfigurationChangeListener; 031 032 033 034/** 035 * A server-side interface for querying File Count Log Retention 036 * Policy settings. 037 * <p> 038 * Retention policy based on the number of rotated log files on disk. 039 */ 040public interface FileCountLogRetentionPolicyCfg extends LogRetentionPolicyCfg { 041 042 /** 043 * Gets the configuration class associated with this File Count Log Retention Policy. 044 * 045 * @return Returns the configuration class associated with this File Count Log Retention Policy. 046 */ 047 Class<? extends FileCountLogRetentionPolicyCfg> configurationClass(); 048 049 050 051 /** 052 * Register to be notified when this File Count Log Retention Policy is changed. 053 * 054 * @param listener 055 * The File Count Log Retention Policy configuration change listener. 056 */ 057 void addFileCountChangeListener(ConfigurationChangeListener<FileCountLogRetentionPolicyCfg> listener); 058 059 060 061 /** 062 * Deregister an existing File Count Log Retention Policy configuration change listener. 063 * 064 * @param listener 065 * The File Count Log Retention Policy configuration change listener. 066 */ 067 void removeFileCountChangeListener(ConfigurationChangeListener<FileCountLogRetentionPolicyCfg> listener); 068 069 070 071 /** 072 * Gets the "java-class" property. 073 * <p> 074 * Specifies the fully-qualified name of the Java class that 075 * provides the File Count Log Retention Policy implementation. 076 * 077 * @return Returns the value of the "java-class" property. 078 */ 079 String getJavaClass(); 080 081 082 083 /** 084 * Gets the "number-of-files" property. 085 * <p> 086 * Specifies the number of archived log files to retain before the 087 * oldest ones are cleaned. 088 * 089 * @return Returns the value of the "number-of-files" property. 090 */ 091 int getNumberOfFiles(); 092 093}