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 java.util.Collection; 021import java.util.SortedSet; 022import org.forgerock.opendj.config.ManagedObjectDefinition; 023import org.forgerock.opendj.config.PropertyException; 024import org.forgerock.opendj.server.config.server.FixedTimeLogRotationPolicyCfg; 025 026 027 028/** 029 * A client-side interface for reading and modifying Fixed Time Log 030 * Rotation Policy settings. 031 * <p> 032 * Rotation policy based on a fixed time of day. 033 */ 034public interface FixedTimeLogRotationPolicyCfgClient extends LogRotationPolicyCfgClient { 035 036 /** 037 * Get the configuration definition associated with this Fixed Time Log Rotation Policy. 038 * 039 * @return Returns the configuration definition associated with this Fixed Time Log Rotation Policy. 040 */ 041 ManagedObjectDefinition<? extends FixedTimeLogRotationPolicyCfgClient, ? extends FixedTimeLogRotationPolicyCfg> definition(); 042 043 044 045 /** 046 * Gets the "java-class" property. 047 * <p> 048 * Specifies the fully-qualified name of the Java class that 049 * provides the Fixed Time Log Rotation Policy implementation. 050 * 051 * @return Returns the value of the "java-class" property. 052 */ 053 String getJavaClass(); 054 055 056 057 /** 058 * Sets the "java-class" property. 059 * <p> 060 * Specifies the fully-qualified name of the Java class that 061 * provides the Fixed Time Log Rotation Policy implementation. 062 * 063 * @param value The value of the "java-class" property. 064 * @throws PropertyException 065 * If the new value is invalid. 066 */ 067 void setJavaClass(String value) throws PropertyException; 068 069 070 071 /** 072 * Gets the "time-of-day" property. 073 * <p> 074 * Specifies the time of day at which log rotation should occur. 075 * 076 * @return Returns the values of the "time-of-day" property. 077 */ 078 SortedSet<String> getTimeOfDay(); 079 080 081 082 /** 083 * Sets the "time-of-day" property. 084 * <p> 085 * Specifies the time of day at which log rotation should occur. 086 * 087 * @param values The values of the "time-of-day" property. 088 * @throws PropertyException 089 * If one or more of the new values are invalid. 090 */ 091 void setTimeOfDay(Collection<String> values) throws PropertyException; 092 093}