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