001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.meta; 017 018 019 020import org.forgerock.opendj.config.AdministratorAction; 021import org.forgerock.opendj.config.ClassPropertyDefinition; 022import org.forgerock.opendj.config.client.ConcurrentModificationException; 023import org.forgerock.opendj.config.client.ManagedObject; 024import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException; 025import org.forgerock.opendj.config.client.OperationRejectedException; 026import org.forgerock.opendj.config.DefaultBehaviorProvider; 027import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider; 028import org.forgerock.opendj.config.IntegerPropertyDefinition; 029import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException; 030import org.forgerock.opendj.config.ManagedObjectDefinition; 031import org.forgerock.opendj.config.PropertyOption; 032import org.forgerock.opendj.config.PropertyProvider; 033import org.forgerock.opendj.config.server.ConfigurationChangeListener; 034import org.forgerock.opendj.config.server.ServerManagedObject; 035import org.forgerock.opendj.config.Tag; 036import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider; 037import org.forgerock.opendj.ldap.DN; 038import org.forgerock.opendj.ldap.LdapException; 039import org.forgerock.opendj.server.config.client.FileCountLogRetentionPolicyCfgClient; 040import org.forgerock.opendj.server.config.server.FileCountLogRetentionPolicyCfg; 041import org.forgerock.opendj.server.config.server.LogRetentionPolicyCfg; 042 043 044 045/** 046 * An interface for querying the File Count Log Retention Policy 047 * managed object definition meta information. 048 * <p> 049 * Retention policy based on the number of rotated log files on disk. 050 */ 051public final class FileCountLogRetentionPolicyCfgDefn extends ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient, FileCountLogRetentionPolicyCfg> { 052 053 /** The singleton configuration definition instance. */ 054 private static final FileCountLogRetentionPolicyCfgDefn INSTANCE = new FileCountLogRetentionPolicyCfgDefn(); 055 056 057 058 /** The "java-class" property definition. */ 059 private static final ClassPropertyDefinition PD_JAVA_CLASS; 060 061 062 063 /** The "number-of-files" property definition. */ 064 private static final IntegerPropertyDefinition PD_NUMBER_OF_FILES; 065 066 067 068 /** Build the "java-class" property definition. */ 069 static { 070 ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class"); 071 builder.setOption(PropertyOption.MANDATORY); 072 builder.setOption(PropertyOption.ADVANCED); 073 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class")); 074 DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.loggers.FileNumberRetentionPolicy"); 075 builder.setDefaultBehaviorProvider(provider); 076 builder.addInstanceOf("org.opends.server.loggers.RetentionPolicy"); 077 PD_JAVA_CLASS = builder.getInstance(); 078 INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS); 079 } 080 081 082 083 /** Build the "number-of-files" property definition. */ 084 static { 085 IntegerPropertyDefinition.Builder builder = IntegerPropertyDefinition.createBuilder(INSTANCE, "number-of-files"); 086 builder.setOption(PropertyOption.MANDATORY); 087 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "number-of-files")); 088 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Integer>()); 089 builder.setLowerLimit(1); 090 PD_NUMBER_OF_FILES = builder.getInstance(); 091 INSTANCE.registerPropertyDefinition(PD_NUMBER_OF_FILES); 092 } 093 094 095 096 // Register the tags associated with this managed object definition. 097 static { 098 INSTANCE.registerTag(Tag.valueOf("logging")); 099 } 100 101 102 103 /** 104 * Get the File Count Log Retention Policy configuration definition 105 * singleton. 106 * 107 * @return Returns the File Count Log Retention Policy configuration 108 * definition singleton. 109 */ 110 public static FileCountLogRetentionPolicyCfgDefn getInstance() { 111 return INSTANCE; 112 } 113 114 115 116 /** 117 * Private constructor. 118 */ 119 private FileCountLogRetentionPolicyCfgDefn() { 120 super("file-count-log-retention-policy", LogRetentionPolicyCfgDefn.getInstance()); 121 } 122 123 124 125 /** {@inheritDoc} */ 126 public FileCountLogRetentionPolicyCfgClient createClientConfiguration( 127 ManagedObject<? extends FileCountLogRetentionPolicyCfgClient> impl) { 128 return new FileCountLogRetentionPolicyCfgClientImpl(impl); 129 } 130 131 132 133 /** {@inheritDoc} */ 134 public FileCountLogRetentionPolicyCfg createServerConfiguration( 135 ServerManagedObject<? extends FileCountLogRetentionPolicyCfg> impl) { 136 return new FileCountLogRetentionPolicyCfgServerImpl(impl); 137 } 138 139 140 141 /** {@inheritDoc} */ 142 public Class<FileCountLogRetentionPolicyCfg> getServerConfigurationClass() { 143 return FileCountLogRetentionPolicyCfg.class; 144 } 145 146 147 148 /** 149 * Get the "java-class" property definition. 150 * <p> 151 * Specifies the fully-qualified name of the Java class that 152 * provides the File Count Log Retention Policy implementation. 153 * 154 * @return Returns the "java-class" property definition. 155 */ 156 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 157 return PD_JAVA_CLASS; 158 } 159 160 161 162 /** 163 * Get the "number-of-files" property definition. 164 * <p> 165 * Specifies the number of archived log files to retain before the 166 * oldest ones are cleaned. 167 * 168 * @return Returns the "number-of-files" property definition. 169 */ 170 public IntegerPropertyDefinition getNumberOfFilesPropertyDefinition() { 171 return PD_NUMBER_OF_FILES; 172 } 173 174 175 176 /** 177 * Managed object client implementation. 178 */ 179 private static class FileCountLogRetentionPolicyCfgClientImpl implements 180 FileCountLogRetentionPolicyCfgClient { 181 182 /** Private implementation. */ 183 private ManagedObject<? extends FileCountLogRetentionPolicyCfgClient> impl; 184 185 186 187 /** Private constructor. */ 188 private FileCountLogRetentionPolicyCfgClientImpl( 189 ManagedObject<? extends FileCountLogRetentionPolicyCfgClient> impl) { 190 this.impl = impl; 191 } 192 193 194 195 /** {@inheritDoc} */ 196 public String getJavaClass() { 197 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 198 } 199 200 201 202 /** {@inheritDoc} */ 203 public void setJavaClass(String value) { 204 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 205 } 206 207 208 209 /** {@inheritDoc} */ 210 public Integer getNumberOfFiles() { 211 return impl.getPropertyValue(INSTANCE.getNumberOfFilesPropertyDefinition()); 212 } 213 214 215 216 /** {@inheritDoc} */ 217 public void setNumberOfFiles(int value) { 218 impl.setPropertyValue(INSTANCE.getNumberOfFilesPropertyDefinition(), value); 219 } 220 221 222 223 /** {@inheritDoc} */ 224 public ManagedObjectDefinition<? extends FileCountLogRetentionPolicyCfgClient, ? extends FileCountLogRetentionPolicyCfg> definition() { 225 return INSTANCE; 226 } 227 228 229 230 /** {@inheritDoc} */ 231 public PropertyProvider properties() { 232 return impl; 233 } 234 235 236 237 /** {@inheritDoc} */ 238 public void commit() throws ManagedObjectAlreadyExistsException, 239 MissingMandatoryPropertiesException, ConcurrentModificationException, 240 OperationRejectedException, LdapException { 241 impl.commit(); 242 } 243 244 245 246 /** {@inheritDoc} */ 247 public String toString() { 248 return impl.toString(); 249 } 250 } 251 252 253 254 /** 255 * Managed object server implementation. 256 */ 257 private static class FileCountLogRetentionPolicyCfgServerImpl implements 258 FileCountLogRetentionPolicyCfg { 259 260 /** Private implementation. */ 261 private ServerManagedObject<? extends FileCountLogRetentionPolicyCfg> impl; 262 263 /** The value of the "java-class" property. */ 264 private final String pJavaClass; 265 266 /** The value of the "number-of-files" property. */ 267 private final int pNumberOfFiles; 268 269 270 271 /** Private constructor. */ 272 private FileCountLogRetentionPolicyCfgServerImpl(ServerManagedObject<? extends FileCountLogRetentionPolicyCfg> impl) { 273 this.impl = impl; 274 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 275 this.pNumberOfFiles = impl.getPropertyValue(INSTANCE.getNumberOfFilesPropertyDefinition()); 276 } 277 278 279 280 /** {@inheritDoc} */ 281 public void addFileCountChangeListener( 282 ConfigurationChangeListener<FileCountLogRetentionPolicyCfg> listener) { 283 impl.registerChangeListener(listener); 284 } 285 286 287 288 /** {@inheritDoc} */ 289 public void removeFileCountChangeListener( 290 ConfigurationChangeListener<FileCountLogRetentionPolicyCfg> listener) { 291 impl.deregisterChangeListener(listener); 292 } 293 /** {@inheritDoc} */ 294 public void addChangeListener( 295 ConfigurationChangeListener<LogRetentionPolicyCfg> listener) { 296 impl.registerChangeListener(listener); 297 } 298 299 300 301 /** {@inheritDoc} */ 302 public void removeChangeListener( 303 ConfigurationChangeListener<LogRetentionPolicyCfg> listener) { 304 impl.deregisterChangeListener(listener); 305 } 306 307 308 309 /** {@inheritDoc} */ 310 public String getJavaClass() { 311 return pJavaClass; 312 } 313 314 315 316 /** {@inheritDoc} */ 317 public int getNumberOfFiles() { 318 return pNumberOfFiles; 319 } 320 321 322 323 /** {@inheritDoc} */ 324 public Class<? extends FileCountLogRetentionPolicyCfg> configurationClass() { 325 return FileCountLogRetentionPolicyCfg.class; 326 } 327 328 329 330 /** {@inheritDoc} */ 331 public DN dn() { 332 return impl.getDN(); 333 } 334 335 336 337 /** {@inheritDoc} */ 338 public String toString() { 339 return impl.toString(); 340 } 341 } 342}