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 Error Log Publisher 038 * settings. 039 * <p> 040 * File Based Error Log Publishers publish error messages to the file 041 * system. 042 */ 043public interface FileBasedErrorLogPublisherCfg extends ErrorLogPublisherCfg { 044 045 /** 046 * Gets the configuration class associated with this File Based Error Log Publisher. 047 * 048 * @return Returns the configuration class associated with this File Based Error Log Publisher. 049 */ 050 Class<? extends FileBasedErrorLogPublisherCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this File Based Error Log Publisher is changed. 056 * 057 * @param listener 058 * The File Based Error Log Publisher configuration change listener. 059 */ 060 void addFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> listener); 061 062 063 064 /** 065 * Deregister an existing File Based Error Log Publisher configuration change listener. 066 * 067 * @param listener 068 * The File Based Error Log Publisher configuration change listener. 069 */ 070 void removeFileBasedErrorChangeListener(ConfigurationChangeListener<FileBasedErrorLogPublisherCfg> 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 Error 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 will be 103 * flushed 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 Error 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 Error Log Publisher . 139 * <p> 140 * The path to the file is relative to 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 * Error 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 Error Log 176 * Publisher . 177 * <p> 178 * When multiple policies are used, log files will be cleaned when 179 * any 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 Error Log 191 * Publisher . 192 * <p> 193 * When multiple policies are used, log files will be cleaned when 194 * any 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 Error Log Publisher 206 * . 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 Error Log Publisher 221 * . 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}