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 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.FileCountLogRetentionPolicyCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying File Count Log 028 * Retention Policy settings. 029 * <p> 030 * Retention policy based on the number of rotated log files on disk. 031 */ 032public interface FileCountLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient { 033 034 /** 035 * Get the configuration definition associated with this File Count Log Retention Policy. 036 * 037 * @return Returns the configuration definition associated with this File Count Log Retention Policy. 038 */ 039 ManagedObjectDefinition<? extends FileCountLogRetentionPolicyCfgClient, ? extends FileCountLogRetentionPolicyCfg> definition(); 040 041 042 043 /** 044 * Gets the "java-class" property. 045 * <p> 046 * Specifies the fully-qualified name of the Java class that 047 * provides the File Count Log Retention Policy implementation. 048 * 049 * @return Returns the value of the "java-class" property. 050 */ 051 String getJavaClass(); 052 053 054 055 /** 056 * Sets the "java-class" property. 057 * <p> 058 * Specifies the fully-qualified name of the Java class that 059 * provides the File Count Log Retention Policy implementation. 060 * 061 * @param value The value of the "java-class" property. 062 * @throws PropertyException 063 * If the new value is invalid. 064 */ 065 void setJavaClass(String value) throws PropertyException; 066 067 068 069 /** 070 * Gets the "number-of-files" property. 071 * <p> 072 * Specifies the number of archived log files to retain before the 073 * oldest ones are cleaned. 074 * 075 * @return Returns the value of the "number-of-files" property. 076 */ 077 Integer getNumberOfFiles(); 078 079 080 081 /** 082 * Sets the "number-of-files" property. 083 * <p> 084 * Specifies the number of archived log files to retain before the 085 * oldest ones are cleaned. 086 * 087 * @param value The value of the "number-of-files" property. 088 * @throws PropertyException 089 * If the new value is invalid. 090 */ 091 void setNumberOfFiles(int value) throws PropertyException; 092 093}