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.ManagedObjectAlreadyExistsException; 038import org.forgerock.opendj.config.ManagedObjectDefinition; 039import org.forgerock.opendj.config.PropertyException; 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.Tag; 045import org.forgerock.opendj.config.TopCfgDefn; 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.AttributeSyntaxCfgClient; 050import org.forgerock.opendj.server.config.server.AttributeSyntaxCfg; 051 052 053 054/** 055 * An interface for querying the Attribute Syntax managed object 056 * definition meta information. 057 * <p> 058 * Attribute Syntaxes define the type of data that may be stored in an 059 * attribute with that syntax. A syntax is generally associated with a 060 * set of matching rules that indicate how to perform matching 061 * operations against values of that syntax. 062 */ 063public final class AttributeSyntaxCfgDefn extends ManagedObjectDefinition<AttributeSyntaxCfgClient, AttributeSyntaxCfg> { 064 065 // The singleton configuration definition instance. 066 private static final AttributeSyntaxCfgDefn INSTANCE = new AttributeSyntaxCfgDefn(); 067 068 069 070 // The "enabled" property definition. 071 private static final BooleanPropertyDefinition PD_ENABLED; 072 073 074 075 // The "java-class" property definition. 076 private static final ClassPropertyDefinition PD_JAVA_CLASS; 077 078 079 080 // Build the "enabled" property definition. 081 static { 082 BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE, "enabled"); 083 builder.setOption(PropertyOption.MANDATORY); 084 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "enabled")); 085 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Boolean>()); 086 PD_ENABLED = builder.getInstance(); 087 INSTANCE.registerPropertyDefinition(PD_ENABLED); 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.READ_ONLY); 096 builder.setOption(PropertyOption.MANDATORY); 097 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class")); 098 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>()); 099 builder.addInstanceOf("org.opends.server.api.AttributeSyntax"); 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("core-server")); 109 } 110 111 112 113 /** 114 * Get the Attribute Syntax configuration definition singleton. 115 * 116 * @return Returns the Attribute Syntax configuration definition 117 * singleton. 118 */ 119 public static AttributeSyntaxCfgDefn getInstance() { 120 return INSTANCE; 121 } 122 123 124 125 /** 126 * Private constructor. 127 */ 128 private AttributeSyntaxCfgDefn() { 129 super("attribute-syntax", TopCfgDefn.getInstance()); 130 } 131 132 133 134 /** 135 * {@inheritDoc} 136 */ 137 public AttributeSyntaxCfgClient createClientConfiguration( 138 ManagedObject<? extends AttributeSyntaxCfgClient> impl) { 139 return new AttributeSyntaxCfgClientImpl(impl); 140 } 141 142 143 144 /** 145 * {@inheritDoc} 146 */ 147 public AttributeSyntaxCfg createServerConfiguration( 148 ServerManagedObject<? extends AttributeSyntaxCfg> impl) { 149 return new AttributeSyntaxCfgServerImpl(impl); 150 } 151 152 153 154 /** 155 * {@inheritDoc} 156 */ 157 public Class<AttributeSyntaxCfg> getServerConfigurationClass() { 158 return AttributeSyntaxCfg.class; 159 } 160 161 162 163 /** 164 * Get the "enabled" property definition. 165 * <p> 166 * Indicates whether the Attribute Syntax is enabled. 167 * 168 * @return Returns the "enabled" property definition. 169 */ 170 public BooleanPropertyDefinition getEnabledPropertyDefinition() { 171 return PD_ENABLED; 172 } 173 174 175 176 /** 177 * Get the "java-class" property definition. 178 * <p> 179 * Specifies the fully-qualified name of the Java class that 180 * provides the Attribute Syntax implementation. 181 * 182 * @return Returns the "java-class" property definition. 183 */ 184 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 185 return PD_JAVA_CLASS; 186 } 187 188 189 190 /** 191 * Managed object client implementation. 192 */ 193 private static class AttributeSyntaxCfgClientImpl implements 194 AttributeSyntaxCfgClient { 195 196 // Private implementation. 197 private ManagedObject<? extends AttributeSyntaxCfgClient> impl; 198 199 200 201 // Private constructor. 202 private AttributeSyntaxCfgClientImpl( 203 ManagedObject<? extends AttributeSyntaxCfgClient> impl) { 204 this.impl = impl; 205 } 206 207 208 209 /** 210 * {@inheritDoc} 211 */ 212 public Boolean isEnabled() { 213 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 214 } 215 216 217 218 /** 219 * {@inheritDoc} 220 */ 221 public void setEnabled(boolean value) { 222 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value); 223 } 224 225 226 227 /** 228 * {@inheritDoc} 229 */ 230 public String getJavaClass() { 231 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 232 } 233 234 235 236 /** 237 * {@inheritDoc} 238 */ 239 public void setJavaClass(String value) throws PropertyException { 240 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 241 } 242 243 244 245 /** 246 * {@inheritDoc} 247 */ 248 public ManagedObjectDefinition<? extends AttributeSyntaxCfgClient, ? extends AttributeSyntaxCfg> definition() { 249 return INSTANCE; 250 } 251 252 253 254 /** 255 * {@inheritDoc} 256 */ 257 public PropertyProvider properties() { 258 return impl; 259 } 260 261 262 263 /** 264 * {@inheritDoc} 265 */ 266 public void commit() throws ManagedObjectAlreadyExistsException, 267 MissingMandatoryPropertiesException, ConcurrentModificationException, 268 OperationRejectedException, LdapException { 269 impl.commit(); 270 } 271 272 } 273 274 275 276 /** 277 * Managed object server implementation. 278 */ 279 private static class AttributeSyntaxCfgServerImpl implements 280 AttributeSyntaxCfg { 281 282 // Private implementation. 283 private ServerManagedObject<? extends AttributeSyntaxCfg> impl; 284 285 // The value of the "enabled" property. 286 private final boolean pEnabled; 287 288 // The value of the "java-class" property. 289 private final String pJavaClass; 290 291 292 293 // Private constructor. 294 private AttributeSyntaxCfgServerImpl(ServerManagedObject<? extends AttributeSyntaxCfg> impl) { 295 this.impl = impl; 296 this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 297 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 298 } 299 300 301 302 /** 303 * {@inheritDoc} 304 */ 305 public void addChangeListener( 306 ConfigurationChangeListener<AttributeSyntaxCfg> listener) { 307 impl.registerChangeListener(listener); 308 } 309 310 311 312 /** 313 * {@inheritDoc} 314 */ 315 public void removeChangeListener( 316 ConfigurationChangeListener<AttributeSyntaxCfg> listener) { 317 impl.deregisterChangeListener(listener); 318 } 319 320 321 322 /** 323 * {@inheritDoc} 324 */ 325 public boolean isEnabled() { 326 return pEnabled; 327 } 328 329 330 331 /** 332 * {@inheritDoc} 333 */ 334 public String getJavaClass() { 335 return pJavaClass; 336 } 337 338 339 340 /** 341 * {@inheritDoc} 342 */ 343 public Class<? extends AttributeSyntaxCfg> configurationClass() { 344 return AttributeSyntaxCfg.class; 345 } 346 347 348 349 /** 350 * {@inheritDoc} 351 */ 352 public DN dn() { 353 return impl.getDN(); 354 } 355 356 } 357}