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