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