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