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