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.server;
027
028
029
030import java.util.SortedSet;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032import org.opends.server.types.DN;
033
034
035
036/**
037 * A server-side interface for querying File Based Audit Log Publisher
038 * settings.
039 * <p>
040 * File Based Audit Log Publishers publish access messages to the file
041 * system.
042 */
043public interface FileBasedAuditLogPublisherCfg extends AccessLogPublisherCfg {
044
045  /**
046   * Gets the configuration class associated with this File Based Audit Log Publisher.
047   *
048   * @return Returns the configuration class associated with this File Based Audit Log Publisher.
049   */
050  Class<? extends FileBasedAuditLogPublisherCfg> configurationClass();
051
052
053
054  /**
055   * Register to be notified when this File Based Audit Log Publisher is changed.
056   *
057   * @param listener
058   *          The File Based Audit Log Publisher configuration change listener.
059   */
060  void addFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener);
061
062
063
064  /**
065   * Deregister an existing File Based Audit Log Publisher configuration change listener.
066   *
067   * @param listener
068   *          The File Based Audit Log Publisher configuration change listener.
069   */
070  void removeFileBasedAuditChangeListener(ConfigurationChangeListener<FileBasedAuditLogPublisherCfg> listener);
071
072
073
074  /**
075   * Gets the "append" property.
076   * <p>
077   * Specifies whether to append to existing log files.
078   *
079   * @return Returns the value of the "append" property.
080   */
081  boolean isAppend();
082
083
084
085  /**
086   * Gets the "asynchronous" property.
087   * <p>
088   * Indicates whether the File Based Audit Log Publisher will publish
089   * records asynchronously.
090   *
091   * @return Returns the value of the "asynchronous" property.
092   */
093  boolean isAsynchronous();
094
095
096
097  /**
098   * Gets the "auto-flush" property.
099   * <p>
100   * Specifies whether to flush the writer after every log record.
101   * <p>
102   * If the asynchronous writes option is used, the writer is flushed
103   * after all the log records in the queue are written.
104   *
105   * @return Returns the value of the "auto-flush" property.
106   */
107  boolean isAutoFlush();
108
109
110
111  /**
112   * Gets the "buffer-size" property.
113   * <p>
114   * Specifies the log file buffer size.
115   *
116   * @return Returns the value of the "buffer-size" property.
117   */
118  long getBufferSize();
119
120
121
122  /**
123   * Gets the "java-class" property.
124   * <p>
125   * The fully-qualified name of the Java class that provides the File
126   * Based Audit Log Publisher implementation.
127   *
128   * @return Returns the value of the "java-class" property.
129   */
130  String getJavaClass();
131
132
133
134  /**
135   * Gets the "log-file" property.
136   * <p>
137   * The file name to use for the log files generated by the File
138   * Based Audit Log Publisher. The path to the file is relative to the
139   * server root.
140   *
141   * @return Returns the value of the "log-file" property.
142   */
143  String getLogFile();
144
145
146
147  /**
148   * Gets the "log-file-permissions" property.
149   * <p>
150   * The UNIX permissions of the log files created by this File Based
151   * Audit Log Publisher.
152   *
153   * @return Returns the value of the "log-file-permissions" property.
154   */
155  String getLogFilePermissions();
156
157
158
159  /**
160   * Gets the "queue-size" property.
161   * <p>
162   * The maximum number of log records that can be stored in the
163   * asynchronous queue.
164   * <p>
165   * Setting the queue size to zero activates parallel log writer
166   * implementation which has no queue size limit and as such the
167   * parallel log writer should only be used on a very well tuned
168   * server configuration to avoid potential out of memory errors.
169   *
170   * @return Returns the value of the "queue-size" property.
171   */
172  int getQueueSize();
173
174
175
176  /**
177   * Gets the "retention-policy" property.
178   * <p>
179   * The retention policy to use for the File Based Audit Log
180   * Publisher .
181   * <p>
182   * When multiple policies are used, log files are cleaned when any
183   * of the policy's conditions are met.
184   *
185   * @return Returns an unmodifiable set containing the values of the "retention-policy" property.
186   */
187  SortedSet<String> getRetentionPolicy();
188
189
190
191  /**
192   * Gets the "retention-policy" property as a set of DNs.
193   * <p>
194   * The retention policy to use for the File Based Audit Log
195   * Publisher .
196   * <p>
197   * When multiple policies are used, log files are cleaned when any
198   * of the policy's conditions are met.
199   *
200   * @return Returns the DN values of the "retention-policy" property.
201   */
202  SortedSet<DN> getRetentionPolicyDNs();
203
204
205
206  /**
207   * Gets the "rotation-policy" property.
208   * <p>
209   * The rotation policy to use for the File Based Audit Log Publisher
210   * .
211   * <p>
212   * When multiple policies are used, rotation will occur if any
213   * policy's conditions are met.
214   *
215   * @return Returns an unmodifiable set containing the values of the "rotation-policy" property.
216   */
217  SortedSet<String> getRotationPolicy();
218
219
220
221  /**
222   * Gets the "rotation-policy" property as a set of DNs.
223   * <p>
224   * The rotation policy to use for the File Based Audit Log Publisher
225   * .
226   * <p>
227   * When multiple policies are used, rotation will occur if any
228   * policy's conditions are met.
229   *
230   * @return Returns the DN values of the "rotation-policy" property.
231   */
232  SortedSet<DN> getRotationPolicyDNs();
233
234
235
236  /**
237   * Gets the "time-interval" property.
238   * <p>
239   * Specifies the interval at which to check whether the log files
240   * need to be rotated.
241   *
242   * @return Returns the value of the "time-interval" property.
243   */
244  long getTimeInterval();
245
246}