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