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 org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.SizeLimitLogRotationPolicyCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying Size Limit Log
038 * Rotation Policy settings.
039 * <p>
040 * Rotation policy based on the size of the log file.
041 */
042public interface SizeLimitLogRotationPolicyCfgClient extends LogRotationPolicyCfgClient {
043
044  /**
045   * Get the configuration definition associated with this Size Limit Log Rotation Policy.
046   *
047   * @return Returns the configuration definition associated with this Size Limit Log Rotation Policy.
048   */
049  ManagedObjectDefinition<? extends SizeLimitLogRotationPolicyCfgClient, ? extends SizeLimitLogRotationPolicyCfg> definition();
050
051
052
053  /**
054   * Gets the "file-size-limit" property.
055   * <p>
056   * Specifies the maximum size that a log file can reach before it is
057   * rotated.
058   *
059   * @return Returns the value of the "file-size-limit" property.
060   */
061  Long getFileSizeLimit();
062
063
064
065  /**
066   * Sets the "file-size-limit" property.
067   * <p>
068   * Specifies the maximum size that a log file can reach before it is
069   * rotated.
070   *
071   * @param value The value of the "file-size-limit" property.
072   * @throws PropertyException
073   *           If the new value is invalid.
074   */
075  void setFileSizeLimit(long value) throws PropertyException;
076
077
078
079  /**
080   * Gets the "java-class" property.
081   * <p>
082   * Specifies the fully-qualified name of the Java class that
083   * provides the Size Limit Log Rotation Policy implementation.
084   *
085   * @return Returns the value of the "java-class" property.
086   */
087  String getJavaClass();
088
089
090
091  /**
092   * Sets the "java-class" property.
093   * <p>
094   * Specifies the fully-qualified name of the Java class that
095   * provides the Size Limit Log Rotation Policy implementation.
096   *
097   * @param value The value of the "java-class" property.
098   * @throws PropertyException
099   *           If the new value is invalid.
100   */
101  void setJavaClass(String value) throws PropertyException;
102
103}