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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.client; 028 029 030 031 import org.opends.server.admin.IllegalPropertyValueException; 032 import org.opends.server.admin.ManagedObjectDefinition; 033 import org.opends.server.admin.std.server.FileCountLogRetentionPolicyCfg; 034 035 036 037 /** 038 * A client-side interface for reading and modifying File Count Log 039 * Retention Policy settings. 040 * <p> 041 * Retention policy based on the number of rotated log files on disk. 042 */ 043 public interface FileCountLogRetentionPolicyCfgClient extends LogRetentionPolicyCfgClient { 044 045 /** 046 * Get the configuration definition associated with this File Count Log Retention Policy. 047 * 048 * @return Returns the configuration definition associated with this File Count Log Retention Policy. 049 */ 050 ManagedObjectDefinition<? extends FileCountLogRetentionPolicyCfgClient, ? extends FileCountLogRetentionPolicyCfg> definition(); 051 052 053 054 /** 055 * Gets the "java-class" property. 056 * <p> 057 * Specifies the fully-qualified name of the Java class that 058 * provides the File Count Log Retention Policy implementation. 059 * 060 * @return Returns the value of the "java-class" property. 061 */ 062 String getJavaClass(); 063 064 065 066 /** 067 * Sets the "java-class" property. 068 * <p> 069 * Specifies the fully-qualified name of the Java class that 070 * provides the File Count Log Retention Policy implementation. 071 * 072 * @param value The value of the "java-class" property. 073 * @throws IllegalPropertyValueException 074 * If the new value is invalid. 075 */ 076 void setJavaClass(String value) throws IllegalPropertyValueException; 077 078 079 080 /** 081 * Gets the "number-of-files" property. 082 * <p> 083 * Specifies the number of archived log files to retain before the 084 * oldest ones are cleaned. 085 * 086 * @return Returns the value of the "number-of-files" property. 087 */ 088 Integer getNumberOfFiles(); 089 090 091 092 /** 093 * Sets the "number-of-files" property. 094 * <p> 095 * Specifies the number of archived log files to retain before the 096 * oldest ones are cleaned. 097 * 098 * @param value The value of the "number-of-files" property. 099 * @throws IllegalPropertyValueException 100 * If the new value is invalid. 101 */ 102 void setNumberOfFiles(int value) throws IllegalPropertyValueException; 103 104 }