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
010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012 * See the License for the specific language governing permissions
013 * and limitations under the License.
014 *
015 * When distributing Covered Code, include this CDDL HEADER in each
016 * file and include the License file at
017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
018 * add the following below this CDDL HEADER, with the fields enclosed
019 * by brackets "[]" replaced with your own identifying information:
020 * Portions Copyright [yyyy] [name of copyright owner]
021 *
022 * CDDL HEADER END
023 *
024 *
025 * Copyright 2008 Sun Microsystems, Inc.
026 */
027 package org.opends.server.admin.std.meta;
028
029
030
031 import org.opends.server.admin.AdministratorAction;
032 import org.opends.server.admin.BooleanPropertyDefinition;
033 import org.opends.server.admin.ClassPropertyDefinition;
034 import org.opends.server.admin.client.AuthorizationException;
035 import org.opends.server.admin.client.CommunicationException;
036 import org.opends.server.admin.client.ConcurrentModificationException;
037 import org.opends.server.admin.client.ManagedObject;
038 import org.opends.server.admin.client.MissingMandatoryPropertiesException;
039 import org.opends.server.admin.client.OperationRejectedException;
040 import org.opends.server.admin.DefaultBehaviorProvider;
041 import org.opends.server.admin.DefinedDefaultBehaviorProvider;
042 import org.opends.server.admin.ManagedObjectAlreadyExistsException;
043 import org.opends.server.admin.ManagedObjectDefinition;
044 import org.opends.server.admin.PropertyOption;
045 import org.opends.server.admin.PropertyProvider;
046 import org.opends.server.admin.server.ConfigurationChangeListener;
047 import org.opends.server.admin.server.ServerManagedObject;
048 import org.opends.server.admin.std.client.AnonymousSASLMechanismHandlerCfgClient;
049 import org.opends.server.admin.std.server.AnonymousSASLMechanismHandlerCfg;
050 import org.opends.server.admin.std.server.SASLMechanismHandlerCfg;
051 import org.opends.server.admin.Tag;
052 import org.opends.server.types.DN;
053
054
055
056 /**
057 * An interface for querying the Anonymous SASL Mechanism Handler
058 * managed object definition meta information.
059 * <p>
060 * The ANONYMOUS SASL mechanism provides the ability for clients to
061 * perform an anonymous bind using a SASL mechanism.
062 */
063 public final class AnonymousSASLMechanismHandlerCfgDefn extends ManagedObjectDefinition<AnonymousSASLMechanismHandlerCfgClient, AnonymousSASLMechanismHandlerCfg> {
064
065 // The singleton configuration definition instance.
066 private static final AnonymousSASLMechanismHandlerCfgDefn INSTANCE = new AnonymousSASLMechanismHandlerCfgDefn();
067
068
069
070 // The "java-class" property definition.
071 private static final ClassPropertyDefinition PD_JAVA_CLASS;
072
073
074
075 // Build the "java-class" property definition.
076 static {
077 ClassPropertyDefinition.Builder builder = ClassPropertyDefinition.createBuilder(INSTANCE, "java-class");
078 builder.setOption(PropertyOption.MANDATORY);
079 builder.setOption(PropertyOption.ADVANCED);
080 builder.setAdministratorAction(new AdministratorAction(AdministratorAction.Type.COMPONENT_RESTART, INSTANCE, "java-class"));
081 DefaultBehaviorProvider<String> provider = new DefinedDefaultBehaviorProvider<String>("org.opends.server.extensions.AnonymousSASLMechanismHandler");
082 builder.setDefaultBehaviorProvider(provider);
083 builder.addInstanceOf("org.opends.server.api.SASLMechanismHandler");
084 PD_JAVA_CLASS = builder.getInstance();
085 INSTANCE.registerPropertyDefinition(PD_JAVA_CLASS);
086 }
087
088
089
090 // Register the tags associated with this managed object definition.
091 static {
092 INSTANCE.registerTag(Tag.valueOf("security"));
093 }
094
095
096
097 /**
098 * Get the Anonymous SASL Mechanism Handler configuration definition
099 * singleton.
100 *
101 * @return Returns the Anonymous SASL Mechanism Handler
102 * configuration definition singleton.
103 */
104 public static AnonymousSASLMechanismHandlerCfgDefn getInstance() {
105 return INSTANCE;
106 }
107
108
109
110 /**
111 * Private constructor.
112 */
113 private AnonymousSASLMechanismHandlerCfgDefn() {
114 super("anonymous-sasl-mechanism-handler", SASLMechanismHandlerCfgDefn.getInstance());
115 }
116
117
118
119 /**
120 * {@inheritDoc}
121 */
122 public AnonymousSASLMechanismHandlerCfgClient createClientConfiguration(
123 ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> impl) {
124 return new AnonymousSASLMechanismHandlerCfgClientImpl(impl);
125 }
126
127
128
129 /**
130 * {@inheritDoc}
131 */
132 public AnonymousSASLMechanismHandlerCfg createServerConfiguration(
133 ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> impl) {
134 return new AnonymousSASLMechanismHandlerCfgServerImpl(impl);
135 }
136
137
138
139 /**
140 * {@inheritDoc}
141 */
142 public Class<AnonymousSASLMechanismHandlerCfg> getServerConfigurationClass() {
143 return AnonymousSASLMechanismHandlerCfg.class;
144 }
145
146
147
148 /**
149 * Get the "enabled" property definition.
150 * <p>
151 * Indicates whether the SASL mechanism handler is enabled for use.
152 *
153 * @return Returns the "enabled" property definition.
154 */
155 public BooleanPropertyDefinition getEnabledPropertyDefinition() {
156 return SASLMechanismHandlerCfgDefn.getInstance().getEnabledPropertyDefinition();
157 }
158
159
160
161 /**
162 * Get the "java-class" property definition.
163 * <p>
164 * Specifies the fully-qualified name of the Java class that
165 * provides the SASL mechanism handler implementation.
166 *
167 * @return Returns the "java-class" property definition.
168 */
169 public ClassPropertyDefinition getJavaClassPropertyDefinition() {
170 return PD_JAVA_CLASS;
171 }
172
173
174
175 /**
176 * Managed object client implementation.
177 */
178 private static class AnonymousSASLMechanismHandlerCfgClientImpl implements
179 AnonymousSASLMechanismHandlerCfgClient {
180
181 // Private implementation.
182 private ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> impl;
183
184
185
186 // Private constructor.
187 private AnonymousSASLMechanismHandlerCfgClientImpl(
188 ManagedObject<? extends AnonymousSASLMechanismHandlerCfgClient> impl) {
189 this.impl = impl;
190 }
191
192
193
194 /**
195 * {@inheritDoc}
196 */
197 public Boolean isEnabled() {
198 return impl.getPropertyValue(INSTANCE.getEnabledPropertyDefinition());
199 }
200
201
202
203 /**
204 * {@inheritDoc}
205 */
206 public void setEnabled(boolean value) {
207 impl.setPropertyValue(INSTANCE.getEnabledPropertyDefinition(), value);
208 }
209
210
211
212 /**
213 * {@inheritDoc}
214 */
215 public String getJavaClass() {
216 return impl.getPropertyValue(INSTANCE.getJavaClassPropertyDefinition());
217 }
218
219
220
221 /**
222 * {@inheritDoc}
223 */
224 public void setJavaClass(String value) {
225 impl.setPropertyValue(INSTANCE.getJavaClassPropertyDefinition(), value);
226 }
227
228
229
230 /**
231 * {@inheritDoc}
232 */
233 public ManagedObjectDefinition<? extends AnonymousSASLMechanismHandlerCfgClient, ? extends AnonymousSASLMechanismHandlerCfg> definition() {
234 return INSTANCE;
235 }
236
237
238
239 /**
240 * {@inheritDoc}
241 */
242 public PropertyProvider properties() {
243 return impl;
244 }
245
246
247
248 /**
249 * {@inheritDoc}
250 */
251 public void commit() throws ManagedObjectAlreadyExistsException,
252 MissingMandatoryPropertiesException, ConcurrentModificationException,
253 OperationRejectedException, AuthorizationException,
254 CommunicationException {
255 impl.commit();
256 }
257
258 }
259
260
261
262 /**
263 * Managed object server implementation.
264 */
265 private static class AnonymousSASLMechanismHandlerCfgServerImpl implements
266 AnonymousSASLMechanismHandlerCfg {
267
268 // Private implementation.
269 private ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> 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 AnonymousSASLMechanismHandlerCfgServerImpl(ServerManagedObject<? extends AnonymousSASLMechanismHandlerCfg> 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 addAnonymousChangeListener(
292 ConfigurationChangeListener<AnonymousSASLMechanismHandlerCfg> listener) {
293 impl.registerChangeListener(listener);
294 }
295
296
297
298 /**
299 * {@inheritDoc}
300 */
301 public void removeAnonymousChangeListener(
302 ConfigurationChangeListener<AnonymousSASLMechanismHandlerCfg> listener) {
303 impl.deregisterChangeListener(listener);
304 }
305 /**
306 * {@inheritDoc}
307 */
308 public void addChangeListener(
309 ConfigurationChangeListener<SASLMechanismHandlerCfg> listener) {
310 impl.registerChangeListener(listener);
311 }
312
313
314
315 /**
316 * {@inheritDoc}
317 */
318 public void removeChangeListener(
319 ConfigurationChangeListener<SASLMechanismHandlerCfg> 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 AnonymousSASLMechanismHandlerCfg> configurationClass() {
347 return AnonymousSASLMechanismHandlerCfg.class;
348 }
349
350
351
352 /**
353 * {@inheritDoc}
354 */
355 public DN dn() {
356 return impl.getDN();
357 }
358
359 }
360 }