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.forgerock.opendj.server.config.meta; 027 028 029 030import org.forgerock.opendj.config.AdministratorAction; 031import org.forgerock.opendj.config.ClassPropertyDefinition; 032import org.forgerock.opendj.config.client.ConcurrentModificationException; 033import org.forgerock.opendj.config.client.ManagedObject; 034import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException; 035import org.forgerock.opendj.config.client.OperationRejectedException; 036import org.forgerock.opendj.config.DefaultBehaviorProvider; 037import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider; 038import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException; 039import org.forgerock.opendj.config.ManagedObjectDefinition; 040import org.forgerock.opendj.config.PropertyOption; 041import org.forgerock.opendj.config.PropertyProvider; 042import org.forgerock.opendj.config.server.ConfigurationChangeListener; 043import org.forgerock.opendj.config.server.ServerManagedObject; 044import org.forgerock.opendj.config.SizePropertyDefinition; 045import org.forgerock.opendj.config.Tag; 046import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider; 047import org.forgerock.opendj.ldap.DN; 048import org.forgerock.opendj.ldap.LdapException; 049import org.forgerock.opendj.server.config.client.FreeDiskSpaceLogRetentionPolicyCfgClient; 050import org.forgerock.opendj.server.config.server.FreeDiskSpaceLogRetentionPolicyCfg; 051import org.forgerock.opendj.server.config.server.LogRetentionPolicyCfg; 052 053 054 055/** 056 * An interface for querying the Free Disk Space Log Retention Policy 057 * managed object definition meta information. 058 * <p> 059 * Retention policy based on the free disk space available. 060 */ 061public final class FreeDiskSpaceLogRetentionPolicyCfgDefn extends ManagedObjectDefinition<FreeDiskSpaceLogRetentionPolicyCfgClient, FreeDiskSpaceLogRetentionPolicyCfg> { 062 063 // The singleton configuration definition instance. 064 private static final FreeDiskSpaceLogRetentionPolicyCfgDefn INSTANCE = new FreeDiskSpaceLogRetentionPolicyCfgDefn(); 065 066 067 068 // The "free-disk-space" property definition. 069 private static final SizePropertyDefinition PD_FREE_DISK_SPACE; 070 071 072 073 // The "java-class" property definition. 074 private static final ClassPropertyDefinition PD_JAVA_CLASS; 075 076 077 078 // Build the "free-disk-space" property definition. 079 static { 080 SizePropertyDefinition.Builder builder = SizePropertyDefinition.createBuilder(INSTANCE, "free-disk-space"); 081 builder.setOption(PropertyOption.MANDATORY); 082 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "free-disk-space")); 083 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Long>()); 084 builder.setLowerLimit("1"); 085 PD_FREE_DISK_SPACE = builder.getInstance(); 086 INSTANCE.registerPropertyDefinition(PD_FREE_DISK_SPACE); 087 } 088 089 090 091 // Build the "java-class" property definition. 092 static { 093 ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class"); 094 builder.setOption(PropertyOption.MANDATORY); 095 builder.setOption(PropertyOption.ADVANCED); 096 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "java-class")); 097 DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.loggers.FreeDiskSpaceRetentionPolicy"); 098 builder.setDefaultBehaviorProvider(provider); 099 builder.addInstanceOf("org.opends.server.loggers.RetentionPolicy"); 100 PD_JAVA_CLASS = builder.getInstance(); 101 INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS); 102 } 103 104 105 106 // Register the tags associated with this managed object definition. 107 static { 108 INSTANCE.registerTag(Tag.valueOf("logging")); 109 } 110 111 112 113 /** 114 * Get the Free Disk Space Log Retention Policy configuration 115 * definition singleton. 116 * 117 * @return Returns the Free Disk Space Log Retention Policy 118 * configuration definition singleton. 119 */ 120 public static FreeDiskSpaceLogRetentionPolicyCfgDefn getInstance() { 121 return INSTANCE; 122 } 123 124 125 126 /** 127 * Private constructor. 128 */ 129 private FreeDiskSpaceLogRetentionPolicyCfgDefn() { 130 super("free-disk-space-log-retention-policy", LogRetentionPolicyCfgDefn.getInstance()); 131 } 132 133 134 135 /** 136 * {@inheritDoc} 137 */ 138 public FreeDiskSpaceLogRetentionPolicyCfgClient createClientConfiguration( 139 ManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfgClient> impl) { 140 return new FreeDiskSpaceLogRetentionPolicyCfgClientImpl(impl); 141 } 142 143 144 145 /** 146 * {@inheritDoc} 147 */ 148 public FreeDiskSpaceLogRetentionPolicyCfg createServerConfiguration( 149 ServerManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfg> impl) { 150 return new FreeDiskSpaceLogRetentionPolicyCfgServerImpl(impl); 151 } 152 153 154 155 /** 156 * {@inheritDoc} 157 */ 158 public Class<FreeDiskSpaceLogRetentionPolicyCfg> getServerConfigurationClass() { 159 return FreeDiskSpaceLogRetentionPolicyCfg.class; 160 } 161 162 163 164 /** 165 * Get the "free-disk-space" property definition. 166 * <p> 167 * Specifies the minimum amount of free disk space that should be 168 * available on the file system on which the archived log files are 169 * stored. 170 * 171 * @return Returns the "free-disk-space" property definition. 172 */ 173 public SizePropertyDefinition getFreeDiskSpacePropertyDefinition() { 174 return PD_FREE_DISK_SPACE; 175 } 176 177 178 179 /** 180 * Get the "java-class" property definition. 181 * <p> 182 * Specifies the fully-qualified name of the Java class that 183 * provides the Free Disk Space Log Retention Policy implementation. 184 * 185 * @return Returns the "java-class" property definition. 186 */ 187 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 188 return PD_JAVA_CLASS; 189 } 190 191 192 193 /** 194 * Managed object client implementation. 195 */ 196 private static class FreeDiskSpaceLogRetentionPolicyCfgClientImpl implements 197 FreeDiskSpaceLogRetentionPolicyCfgClient { 198 199 // Private implementation. 200 private ManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfgClient> impl; 201 202 203 204 // Private constructor. 205 private FreeDiskSpaceLogRetentionPolicyCfgClientImpl( 206 ManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfgClient> impl) { 207 this.impl = impl; 208 } 209 210 211 212 /** 213 * {@inheritDoc} 214 */ 215 public Long getFreeDiskSpace() { 216 return impl.getPropertyValue(INSTANCE.getFreeDiskSpacePropertyDefinition()); 217 } 218 219 220 221 /** 222 * {@inheritDoc} 223 */ 224 public void setFreeDiskSpace(long value) { 225 impl.setPropertyValue(INSTANCE.getFreeDiskSpacePropertyDefinition(), value); 226 } 227 228 229 230 /** 231 * {@inheritDoc} 232 */ 233 public String getJavaClass() { 234 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 235 } 236 237 238 239 /** 240 * {@inheritDoc} 241 */ 242 public void setJavaClass(String value) { 243 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 244 } 245 246 247 248 /** 249 * {@inheritDoc} 250 */ 251 public ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient, ? extends FreeDiskSpaceLogRetentionPolicyCfg> definition() { 252 return INSTANCE; 253 } 254 255 256 257 /** 258 * {@inheritDoc} 259 */ 260 public PropertyProvider properties() { 261 return impl; 262 } 263 264 265 266 /** 267 * {@inheritDoc} 268 */ 269 public void commit() throws ManagedObjectAlreadyExistsException, 270 MissingMandatoryPropertiesException, ConcurrentModificationException, 271 OperationRejectedException, LdapException { 272 impl.commit(); 273 } 274 275 } 276 277 278 279 /** 280 * Managed object server implementation. 281 */ 282 private static class FreeDiskSpaceLogRetentionPolicyCfgServerImpl implements 283 FreeDiskSpaceLogRetentionPolicyCfg { 284 285 // Private implementation. 286 private ServerManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfg> impl; 287 288 // The value of the "free-disk-space" property. 289 private final long pFreeDiskSpace; 290 291 // The value of the "java-class" property. 292 private final String pJavaClass; 293 294 295 296 // Private constructor. 297 private FreeDiskSpaceLogRetentionPolicyCfgServerImpl(ServerManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfg> impl) { 298 this.impl = impl; 299 this.pFreeDiskSpace = impl.getPropertyValue(INSTANCE.getFreeDiskSpacePropertyDefinition()); 300 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 301 } 302 303 304 305 /** 306 * {@inheritDoc} 307 */ 308 public void addFreeDiskSpaceChangeListener( 309 ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener) { 310 impl.registerChangeListener(listener); 311 } 312 313 314 315 /** 316 * {@inheritDoc} 317 */ 318 public void removeFreeDiskSpaceChangeListener( 319 ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener) { 320 impl.deregisterChangeListener(listener); 321 } 322 /** 323 * {@inheritDoc} 324 */ 325 public void addChangeListener( 326 ConfigurationChangeListener<LogRetentionPolicyCfg> listener) { 327 impl.registerChangeListener(listener); 328 } 329 330 331 332 /** 333 * {@inheritDoc} 334 */ 335 public void removeChangeListener( 336 ConfigurationChangeListener<LogRetentionPolicyCfg> listener) { 337 impl.deregisterChangeListener(listener); 338 } 339 340 341 342 /** 343 * {@inheritDoc} 344 */ 345 public long getFreeDiskSpace() { 346 return pFreeDiskSpace; 347 } 348 349 350 351 /** 352 * {@inheritDoc} 353 */ 354 public String getJavaClass() { 355 return pJavaClass; 356 } 357 358 359 360 /** 361 * {@inheritDoc} 362 */ 363 public Class<? extends FreeDiskSpaceLogRetentionPolicyCfg> configurationClass() { 364 return FreeDiskSpaceLogRetentionPolicyCfg.class; 365 } 366 367 368 369 /** 370 * {@inheritDoc} 371 */ 372 public DN dn() { 373 return impl.getDN(); 374 } 375 376 } 377}