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