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.WhoAmIExtendedOperationHandlerCfgClient; 049import org.forgerock.opendj.server.config.server.ExtendedOperationHandlerCfg; 050import org.forgerock.opendj.server.config.server.WhoAmIExtendedOperationHandlerCfg; 051 052 053 054/** 055 * An interface for querying the Who Am I Extended Operation Handler 056 * managed object definition meta information. 057 * <p> 058 * The Who Am I Extended Operation Handler provides the ability for 059 * clients to request their authorization identity using the "Who Am 060 * I?" extended operation as defined in RFC 4532. 061 */ 062public final class WhoAmIExtendedOperationHandlerCfgDefn extends ManagedObjectDefinition<WhoAmIExtendedOperationHandlerCfgClient, WhoAmIExtendedOperationHandlerCfg> { 063 064 // The singleton configuration definition instance. 065 private static final WhoAmIExtendedOperationHandlerCfgDefn INSTANCE = new WhoAmIExtendedOperationHandlerCfgDefn(); 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.WhoAmIExtendedOperation"); 081 builder.setDefaultBehaviorProvider(provider); 082 builder.addInstanceOf("org.opends.server.api.ExtendedOperationHandler"); 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 Who Am I Extended Operation Handler configuration 098 * definition singleton. 099 * 100 * @return Returns the Who Am I Extended Operation Handler 101 * configuration definition singleton. 102 */ 103 public static WhoAmIExtendedOperationHandlerCfgDefn getInstance() { 104 return INSTANCE; 105 } 106 107 108 109 /** 110 * Private constructor. 111 */ 112 private WhoAmIExtendedOperationHandlerCfgDefn() { 113 super("who-am-i-extended-operation-handler", ExtendedOperationHandlerCfgDefn.getInstance()); 114 } 115 116 117 118 /** 119 * {@inheritDoc} 120 */ 121 public WhoAmIExtendedOperationHandlerCfgClient createClientConfiguration( 122 ManagedObject<? extends WhoAmIExtendedOperationHandlerCfgClient> impl) { 123 return new WhoAmIExtendedOperationHandlerCfgClientImpl(impl); 124 } 125 126 127 128 /** 129 * {@inheritDoc} 130 */ 131 public WhoAmIExtendedOperationHandlerCfg createServerConfiguration( 132 ServerManagedObject<? extends WhoAmIExtendedOperationHandlerCfg> impl) { 133 return new WhoAmIExtendedOperationHandlerCfgServerImpl(impl); 134 } 135 136 137 138 /** 139 * {@inheritDoc} 140 */ 141 public Class<WhoAmIExtendedOperationHandlerCfg> getServerConfigurationClass() { 142 return WhoAmIExtendedOperationHandlerCfg.class; 143 } 144 145 146 147 /** 148 * Get the "enabled" property definition. 149 * <p> 150 * Indicates whether the Who Am I Extended Operation Handler is 151 * enabled (that is, whether the types of extended operations are 152 * allowed in the server). 153 * 154 * @return Returns the "enabled" property definition. 155 */ 156 public BooleanPropertyDefinition getEnabledPropertyDefinition() { 157 return ExtendedOperationHandlerCfgDefn.getInstance().getEnabledPropertyDefinition(); 158 } 159 160 161 162 /** 163 * Get the "java-class" property definition. 164 * <p> 165 * Specifies the fully-qualified name of the Java class that 166 * provides the Who Am I Extended Operation Handler implementation. 167 * 168 * @return Returns the "java-class" property definition. 169 */ 170 public ClassPropertyDefinition getJavaClassPropertyDefinition() { 171 return PD_JAVA_CLASS; 172 } 173 174 175 176 /** 177 * Managed object client implementation. 178 */ 179 private static class WhoAmIExtendedOperationHandlerCfgClientImpl implements 180 WhoAmIExtendedOperationHandlerCfgClient { 181 182 // Private implementation. 183 private ManagedObject<? extends WhoAmIExtendedOperationHandlerCfgClient> impl; 184 185 186 187 // Private constructor. 188 private WhoAmIExtendedOperationHandlerCfgClientImpl( 189 ManagedObject<? extends WhoAmIExtendedOperationHandlerCfgClient> impl) { 190 this.impl = impl; 191 } 192 193 194 195 /** 196 * {@inheritDoc} 197 */ 198 public Boolean isEnabled() { 199 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 200 } 201 202 203 204 /** 205 * {@inheritDoc} 206 */ 207 public void setEnabled(boolean value) { 208 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value); 209 } 210 211 212 213 /** 214 * {@inheritDoc} 215 */ 216 public String getJavaClass() { 217 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 218 } 219 220 221 222 /** 223 * {@inheritDoc} 224 */ 225 public void setJavaClass(String value) { 226 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 227 } 228 229 230 231 /** 232 * {@inheritDoc} 233 */ 234 public ManagedObjectDefinition<? extends WhoAmIExtendedOperationHandlerCfgClient, ? extends WhoAmIExtendedOperationHandlerCfg> definition() { 235 return INSTANCE; 236 } 237 238 239 240 /** 241 * {@inheritDoc} 242 */ 243 public PropertyProvider properties() { 244 return impl; 245 } 246 247 248 249 /** 250 * {@inheritDoc} 251 */ 252 public void commit() throws ManagedObjectAlreadyExistsException, 253 MissingMandatoryPropertiesException, ConcurrentModificationException, 254 OperationRejectedException, LdapException { 255 impl.commit(); 256 } 257 258 } 259 260 261 262 /** 263 * Managed object server implementation. 264 */ 265 private static class WhoAmIExtendedOperationHandlerCfgServerImpl implements 266 WhoAmIExtendedOperationHandlerCfg { 267 268 // Private implementation. 269 private ServerManagedObject<? extends WhoAmIExtendedOperationHandlerCfg> 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 WhoAmIExtendedOperationHandlerCfgServerImpl(ServerManagedObject<? extends WhoAmIExtendedOperationHandlerCfg> 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 addWhoAmIChangeListener( 292 ConfigurationChangeListener<WhoAmIExtendedOperationHandlerCfg> listener) { 293 impl.registerChangeListener(listener); 294 } 295 296 297 298 /** 299 * {@inheritDoc} 300 */ 301 public void removeWhoAmIChangeListener( 302 ConfigurationChangeListener<WhoAmIExtendedOperationHandlerCfg> listener) { 303 impl.deregisterChangeListener(listener); 304 } 305 /** 306 * {@inheritDoc} 307 */ 308 public void addChangeListener( 309 ConfigurationChangeListener<ExtendedOperationHandlerCfg> listener) { 310 impl.registerChangeListener(listener); 311 } 312 313 314 315 /** 316 * {@inheritDoc} 317 */ 318 public void removeChangeListener( 319 ConfigurationChangeListener<ExtendedOperationHandlerCfg> 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 WhoAmIExtendedOperationHandlerCfg> configurationClass() { 347 return WhoAmIExtendedOperationHandlerCfg.class; 348 } 349 350 351 352 /** 353 * {@inheritDoc} 354 */ 355 public DN dn() { 356 return impl.getDN(); 357 } 358 359 } 360}