001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.meta; 017 018 019 020import org.forgerock.opendj.config.AdministratorAction; 021import org.forgerock.opendj.config.BooleanPropertyDefinition; 022import org.forgerock.opendj.config.ClassPropertyDefinition; 023import org.forgerock.opendj.config.client.ConcurrentModificationException; 024import org.forgerock.opendj.config.client.ManagedObject; 025import org.forgerock.opendj.config.client.MissingMandatoryPropertiesException; 026import org.forgerock.opendj.config.client.OperationRejectedException; 027import org.forgerock.opendj.config.ManagedObjectAlreadyExistsException; 028import org.forgerock.opendj.config.ManagedObjectDefinition; 029import org.forgerock.opendj.config.PropertyOption; 030import org.forgerock.opendj.config.PropertyProvider; 031import org.forgerock.opendj.config.server.ConfigurationChangeListener; 032import org.forgerock.opendj.config.server.ServerManagedObject; 033import org.forgerock.opendj.config.Tag; 034import org.forgerock.opendj.config.TopCfgDefn; 035import org.forgerock.opendj.config.UndefinedDefaultBehaviorProvider; 036import org.forgerock.opendj.ldap.DN; 037import org.forgerock.opendj.ldap.LdapException; 038import org.forgerock.opendj.server.config.client.IdentityMapperCfgClient; 039import org.forgerock.opendj.server.config.server.IdentityMapperCfg; 040 041 042 043/** 044 * An interface for querying the Identity Mapper managed object 045 * definition meta information. 046 * <p> 047 * Identity Mappers are responsible for establishing a mapping between 048 * an identifier string provided by a client, and the entry for the 049 * user that corresponds to that identifier. Identity Mappers are used 050 * to process several SASL mechanisms to map an authorization ID (e.g., 051 * a Kerberos principal when using GSSAPI) to a directory user. They 052 * are also used when processing requests with the proxied 053 * authorization control. 054 */ 055public final class IdentityMapperCfgDefn extends ManagedObjectDefinition<IdentityMapperCfgClient, IdentityMapperCfg> { 056 057 /** The singleton configuration definition instance. */ 058 private static final IdentityMapperCfgDefn INSTANCE = new IdentityMapperCfgDefn(); 059 060 061 062 /** The "enabled" property definition. */ 063 private static final BooleanPropertyDefinition PD_ENABLED; 064 065 066 067 /** The "java-class" property definition. */ 068 private static final ClassPropertyDefinition PD_JAVA_CLASS; 069 070 071 072 /** Build the "enabled" property definition. */ 073 static { 074 BooleanPropertyDefinition.Builder builder = BooleanPropertyDefinition.createBuilder(INSTANCE, "enabled"); 075 builder.setOption(PropertyOption.MANDATORY); 076 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.NONE, INSTANCE, "enabled")); 077 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<Boolean>()); 078 PD_ENABLED = builder.getInstance(); 079 INSTANCE.registerPropertyDefinition(PD_ENABLED); 080 } 081 082 083 084 /** Build the "java-class" property definition. */ 085 static { 086 ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class"); 087 builder.setOption(PropertyOption.MANDATORY); 088 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class")); 089 builder.setDefaultBehaviorProvider(new UndefinedDefaultBehaviorProvider<String>()); 090 builder.addInstanceOf("org.opends.server.api.IdentityMapper"); 091 PD_JAVA_CLASS = builder.getInstance(); 092 INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS); 093 } 094 095 096 097 // Register the tags associated with this managed object definition. 098 static { 099 INSTANCE.registerTag(Tag.valueOf("security")); 100 INSTANCE.registerTag(Tag.valueOf("user-management")); 101 } 102 103 104 105 /** 106 * Get the Identity Mapper configuration definition singleton. 107 * 108 * @return Returns the Identity Mapper configuration definition 109 * singleton. 110 */ 111 public static IdentityMapperCfgDefn getInstance() { 112 return INSTANCE; 113 } 114 115 116 117 /** 118 * Private constructor. 119 */ 120 private IdentityMapperCfgDefn() { 121 super("identity-mapper", TopCfgDefn.getInstance()); 122 } 123 124 125 126 /** {@inheritDoc} */ 127 public IdentityMapperCfgClient createClientConfiguration( 128 ManagedObject<? extends IdentityMapperCfgClient> impl) { 129 return new IdentityMapperCfgClientImpl(impl); 130 } 131 132 133 134 /** {@inheritDoc} */ 135 public IdentityMapperCfg createServerConfiguration( 136 ServerManagedObject<? extends IdentityMapperCfg> impl) { 137 return new IdentityMapperCfgServerImpl(impl); 138 } 139 140 141 142 /** {@inheritDoc} */ 143 public Class<IdentityMapperCfg> getServerConfigurationClass() { 144 return IdentityMapperCfg.class; 145 } 146 147 148 149 /** 150 * Get the "enabled" property definition. 151 * <p> 152 * Indicates whether the Identity Mapper is enabled for use. 153 * 154 * @return Returns the "enabled" property definition. 155 */ 156 public BooleanPropertyDefinition getEnabledPropertyDefinition() { 157 return PD_ENABLED; 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 Identity Mapper 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 IdentityMapperCfgClientImpl implements 180 IdentityMapperCfgClient { 181 182 /** Private implementation. */ 183 private ManagedObject<? extends IdentityMapperCfgClient> impl; 184 185 186 187 /** Private constructor. */ 188 private IdentityMapperCfgClientImpl( 189 ManagedObject<? extends IdentityMapperCfgClient> impl) { 190 this.impl = impl; 191 } 192 193 194 195 /** {@inheritDoc} */ 196 public Boolean isEnabled() { 197 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 198 } 199 200 201 202 /** {@inheritDoc} */ 203 public void setEnabled(boolean value) { 204 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value); 205 } 206 207 208 209 /** {@inheritDoc} */ 210 public String getJavaClass() { 211 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 212 } 213 214 215 216 /** {@inheritDoc} */ 217 public void setJavaClass(String value) { 218 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value); 219 } 220 221 222 223 /** {@inheritDoc} */ 224 public ManagedObjectDefinition<? extends IdentityMapperCfgClient, ? extends IdentityMapperCfg> definition() { 225 return INSTANCE; 226 } 227 228 229 230 /** {@inheritDoc} */ 231 public PropertyProvider properties() { 232 return impl; 233 } 234 235 236 237 /** {@inheritDoc} */ 238 public void commit() throws ManagedObjectAlreadyExistsException, 239 MissingMandatoryPropertiesException, ConcurrentModificationException, 240 OperationRejectedException, LdapException { 241 impl.commit(); 242 } 243 244 245 246 /** {@inheritDoc} */ 247 public String toString() { 248 return impl.toString(); 249 } 250 } 251 252 253 254 /** 255 * Managed object server implementation. 256 */ 257 private static class IdentityMapperCfgServerImpl implements 258 IdentityMapperCfg { 259 260 /** Private implementation. */ 261 private ServerManagedObject<? extends IdentityMapperCfg> impl; 262 263 /** The value of the "enabled" property. */ 264 private final boolean pEnabled; 265 266 /** The value of the "java-class" property. */ 267 private final String pJavaClass; 268 269 270 271 /** Private constructor. */ 272 private IdentityMapperCfgServerImpl(ServerManagedObject<? extends IdentityMapperCfg> impl) { 273 this.impl = impl; 274 this.pEnabled = impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition()); 275 this.pJavaClass = impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition()); 276 } 277 278 279 280 /** {@inheritDoc} */ 281 public void addChangeListener( 282 ConfigurationChangeListener<IdentityMapperCfg> listener) { 283 impl.registerChangeListener(listener); 284 } 285 286 287 288 /** {@inheritDoc} */ 289 public void removeChangeListener( 290 ConfigurationChangeListener<IdentityMapperCfg> listener) { 291 impl.deregisterChangeListener(listener); 292 } 293 294 295 296 /** {@inheritDoc} */ 297 public boolean isEnabled() { 298 return pEnabled; 299 } 300 301 302 303 /** {@inheritDoc} */ 304 public String getJavaClass() { 305 return pJavaClass; 306 } 307 308 309 310 /** {@inheritDoc} */ 311 public Class<? extends IdentityMapperCfg> configurationClass() { 312 return IdentityMapperCfg.class; 313 } 314 315 316 317 /** {@inheritDoc} */ 318 public DN dn() { 319 return impl.getDN(); 320 } 321 322 323 324 /** {@inheritDoc} */ 325 public String toString() { 326 return impl.toString(); 327 } 328 } 329}