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