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.BooleanPropertyDefinition; 032import org.forgerock.opendj.config.ClassPropertyDefinition; 033import org.forgerock.opendj.config.client.ConcurrentModificationException; 034import org.forgerock.opendj.config.client.ManagedObject; 035import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException; 036import org.forgerock.opendj.config.client.OperationRejectedException; 037import org.forgerock.opendj.config.DefaultBehaviorProvider; 038import org.forgerock.opendj.config.DefinedDefaultBehaviorProvider; 039import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException; 040import org.forgerock.opendj.config.ManagedObjectDefinition; 041import org.forgerock.opendj.config.PropertyOption; 042import org.forgerock.opendj.config.PropertyProvider; 043import org.forgerock.opendj.config.server.ConfigurationChangeListener; 044import org.forgerock.opendj.config.server.ServerManagedObject; 045import org.forgerock.opendj.config.Tag; 046import org.forgerock.opendj.ldap.DN; 047import org.forgerock.opendj.ldap.LdapException; 048import org.forgerock.opendj.server.config.client.DynamicGroupImplementationCfgClient; 049import org.forgerock.opendj.server.config.server.DynamicGroupImplementationCfg; 050import org.forgerock.opendj.server.config.server.GroupImplementationCfg; 051 052 053 054/** 055 * An interface for querying the Dynamic Group Implementation managed 056 * object definition meta information. 057 * <p> 058 * The Dynamic Group Implementation provides a grouping mechanism in 059 * which the group membership is determined based on criteria defined 060 * in one or more LDAP URLs. 061 */ 062public final class DynamicGroupImplementationCfgDefn extends ManagedObjectDefinition<DynamicGroupImplementationCfgClient, DynamicGroupImplementationCfg> { 063 064 // The singleton configuration definition instance. 065 private static final DynamicGroupImplementationCfgDefn INSTANCE = new DynamicGroupImplementationCfgDefn(); 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.COMPONENT_RESTART, INSTANCE, "java-class")); 080 DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.DynamicGroup"); 081 builder.setDefaultBehaviorProvider(provider); 082 builder.addInstanceOf("org.opends.server.api.Group"); 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 Dynamic Group Implementation configuration definition 098 * singleton. 099 * 100 * @return Returns the Dynamic Group Implementation configuration 101 * definition singleton. 102 */ 103 public static DynamicGroupImplementationCfgDefn getInstance() { 104 return INSTANCE; 105 } 106 107 108 109 /** 110 * Private constructor. 111 */ 112 private DynamicGroupImplementationCfgDefn() { 113 super("dynamic-group-implementation", GroupImplementationCfgDefn.getInstance()); 114 } 115 116 117 118 /** 119 * {@inheritDoc} 120 */ 121 public DynamicGroupImplementationCfgClient createClientConfiguration( 122 ManagedObject<? extends DynamicGroupImplementationCfgClient> impl) { 123 return new DynamicGroupImplementationCfgClientImpl(impl); 124 } 125 126 127 128 /** 129 * {@inheritDoc} 130 */ 131 public DynamicGroupImplementationCfg createServerConfiguration( 132 ServerManagedObject<? extends DynamicGroupImplementationCfg> impl) { 133 return new DynamicGroupImplementationCfgServerImpl(impl); 134 } 135 136 137 138 /** 139 * {@inheritDoc} 140 */ 141 public Class<DynamicGroupImplementationCfg> getServerConfigurationClass() { 142 return DynamicGroupImplementationCfg.class; 143 } 144 145 146 147 /** 148 * Get the "enabled" property definition. 149 * <p> 150 * Indicates whether the Dynamic Group Implementation is enabled. 151 * 152 * @return Returns the "enabled" property definition. 153 */ 154 public BooleanPropertyDefinition getEnabledPropertyDefinition() { 155 return GroupImplementationCfgDefn.getInstance().getEnabledPropertyDefinition(); 156 } 157 158 159 160 /** 161 * Get the "java-class" property definition. 162 * <p> 163 * Specifies the fully-qualified name of the Java class that 164 * provides the Dynamic Group Implementation implementation. 165 * 166 * @return Returns the "java-class" property definition. 167 */ 168 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 169 return PD_JAVA_CLASS; 170 } 171 172 173 174 /** 175 * Managed object client implementation. 176 */ 177 private static class DynamicGroupImplementationCfgClientImpl implements 178 DynamicGroupImplementationCfgClient { 179 180 // Private implementation. 181 private ManagedObject<? extends DynamicGroupImplementationCfgClient> impl; 182 183 184 185 // Private constructor. 186 private DynamicGroupImplementationCfgClientImpl( 187 ManagedObject<? extends DynamicGroupImplementationCfgClient> impl) { 188 this.impl = impl; 189 } 190 191 192 193 /** 194 * {@inheritDoc} 195 */ 196 public Boolean isEnabled() { 197 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 198 } 199 200 201 202 /** 203 * {@inheritDoc} 204 */ 205 public void setEnabled(boolean value) { 206 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value); 207 } 208 209 210 211 /** 212 * {@inheritDoc} 213 */ 214 public String getJavaClass() { 215 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 216 } 217 218 219 220 /** 221 * {@inheritDoc} 222 */ 223 public void setJavaClass(String value) { 224 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 225 } 226 227 228 229 /** 230 * {@inheritDoc} 231 */ 232 public ManagedObjectDefinition<? extends DynamicGroupImplementationCfgClient, ? extends DynamicGroupImplementationCfg> definition() { 233 return INSTANCE; 234 } 235 236 237 238 /** 239 * {@inheritDoc} 240 */ 241 public PropertyProvider properties() { 242 return impl; 243 } 244 245 246 247 /** 248 * {@inheritDoc} 249 */ 250 public void commit() throws ManagedObjectAlreadyExistsException, 251 MissingMandatoryPropertiesException, ConcurrentModificationException, 252 OperationRejectedException, LdapException { 253 impl.commit(); 254 } 255 256 } 257 258 259 260 /** 261 * Managed object server implementation. 262 */ 263 private static class DynamicGroupImplementationCfgServerImpl implements 264 DynamicGroupImplementationCfg { 265 266 // Private implementation. 267 private ServerManagedObject<? extends DynamicGroupImplementationCfg> impl; 268 269 // The value of the "enabled" property. 270 private final boolean pEnabled; 271 272 // The value of the "java-class" property. 273 private final String pJavaClass; 274 275 276 277 // Private constructor. 278 private DynamicGroupImplementationCfgServerImpl(ServerManagedObject<? extends DynamicGroupImplementationCfg> impl) { 279 this.impl = impl; 280 this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 281 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 282 } 283 284 285 286 /** 287 * {@inheritDoc} 288 */ 289 public void addDynamicChangeListener( 290 ConfigurationChangeListener<DynamicGroupImplementationCfg> listener) { 291 impl.registerChangeListener(listener); 292 } 293 294 295 296 /** 297 * {@inheritDoc} 298 */ 299 public void removeDynamicChangeListener( 300 ConfigurationChangeListener<DynamicGroupImplementationCfg> listener) { 301 impl.deregisterChangeListener(listener); 302 } 303 /** 304 * {@inheritDoc} 305 */ 306 public void addChangeListener( 307 ConfigurationChangeListener<GroupImplementationCfg> listener) { 308 impl.registerChangeListener(listener); 309 } 310 311 312 313 /** 314 * {@inheritDoc} 315 */ 316 public void removeChangeListener( 317 ConfigurationChangeListener<GroupImplementationCfg> listener) { 318 impl.deregisterChangeListener(listener); 319 } 320 321 322 323 /** 324 * {@inheritDoc} 325 */ 326 public boolean isEnabled() { 327 return pEnabled; 328 } 329 330 331 332 /** 333 * {@inheritDoc} 334 */ 335 public String getJavaClass() { 336 return pJavaClass; 337 } 338 339 340 341 /** 342 * {@inheritDoc} 343 */ 344 public Class<? extends DynamicGroupImplementationCfg> configurationClass() { 345 return DynamicGroupImplementationCfg.class; 346 } 347 348 349 350 /** 351 * {@inheritDoc} 352 */ 353 public DN dn() { 354 return impl.getDN(); 355 } 356 357 } 358}