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