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.client;
028
029
030
031 import java.util.Collection;
032 import org.opends.server.admin.client.AuthorizationException;
033 import org.opends.server.admin.client.CommunicationException;
034 import org.opends.server.admin.client.ConcurrentModificationException;
035 import org.opends.server.admin.client.IllegalManagedObjectNameException;
036 import org.opends.server.admin.client.ManagedObjectDecodingException;
037 import org.opends.server.admin.client.OperationRejectedException;
038 import org.opends.server.admin.ConfigurationClient;
039 import org.opends.server.admin.DefaultBehaviorException;
040 import org.opends.server.admin.DefinitionDecodingException;
041 import org.opends.server.admin.IllegalPropertyValueException;
042 import org.opends.server.admin.ManagedObjectDefinition;
043 import org.opends.server.admin.ManagedObjectNotFoundException;
044 import org.opends.server.admin.std.server.PluginCfg;
045 import org.opends.server.admin.std.server.PluginRootCfg;
046
047
048
049 /**
050 * A client-side interface for reading and modifying Plugin Root
051 * settings.
052 * <p>
053 * The Plugin Root defines the parent entry for all plug-ins defined
054 * in the server.
055 */
056 public interface PluginRootCfgClient extends ConfigurationClient {
057
058 /**
059 * Get the configuration definition associated with this Plugin Root.
060 *
061 * @return Returns the configuration definition associated with this Plugin Root.
062 */
063 ManagedObjectDefinition<? extends PluginRootCfgClient, ? extends PluginRootCfg> definition();
064
065
066
067 /**
068 * Gets the "plugin-order-intermediate-response" property.
069 * <p>
070 * Specifies the order in which intermediate response plug-ins are
071 * to be loaded and invoked.
072 * <p>
073 * The value is a comma-delimited list of plug-in names (where the
074 * plug-in name is the RDN value from the plug-in configuration entry
075 * DN). The list can include at most one asterisk to indicate the
076 * position of any unspecified plug-in (and the relative order of
077 * those unspecified plug-ins is undefined).
078 *
079 * @return Returns the value of the "plugin-order-intermediate-response" property.
080 */
081 String getPluginOrderIntermediateResponse();
082
083
084
085 /**
086 * Sets the "plugin-order-intermediate-response" property.
087 * <p>
088 * Specifies the order in which intermediate response plug-ins are
089 * to be loaded and invoked.
090 * <p>
091 * The value is a comma-delimited list of plug-in names (where the
092 * plug-in name is the RDN value from the plug-in configuration entry
093 * DN). The list can include at most one asterisk to indicate the
094 * position of any unspecified plug-in (and the relative order of
095 * those unspecified plug-ins is undefined).
096 *
097 * @param value The value of the "plugin-order-intermediate-response" property.
098 * @throws IllegalPropertyValueException
099 * If the new value is invalid.
100 */
101 void setPluginOrderIntermediateResponse(String value) throws IllegalPropertyValueException;
102
103
104
105 /**
106 * Gets the "plugin-order-ldif-export" property.
107 * <p>
108 * Specifies the order in which LDIF export plug-ins are to be
109 * loaded and invoked.
110 * <p>
111 * The value is a comma-delimited list of plug-in names (where the
112 * plug-in name is the RDN value from the plug-in configuration entry
113 * DN). The list can include at most one asterisk to indicate the
114 * position of any unspecified plug-in (and the relative order of
115 * those unspecified plug-ins is undefined).
116 *
117 * @return Returns the value of the "plugin-order-ldif-export" property.
118 */
119 String getPluginOrderLDIFExport();
120
121
122
123 /**
124 * Sets the "plugin-order-ldif-export" property.
125 * <p>
126 * Specifies the order in which LDIF export plug-ins are to be
127 * loaded and invoked.
128 * <p>
129 * The value is a comma-delimited list of plug-in names (where the
130 * plug-in name is the RDN value from the plug-in configuration entry
131 * DN). The list can include at most one asterisk to indicate the
132 * position of any unspecified plug-in (and the relative order of
133 * those unspecified plug-ins is undefined).
134 *
135 * @param value The value of the "plugin-order-ldif-export" property.
136 * @throws IllegalPropertyValueException
137 * If the new value is invalid.
138 */
139 void setPluginOrderLDIFExport(String value) throws IllegalPropertyValueException;
140
141
142
143 /**
144 * Gets the "plugin-order-ldif-import" property.
145 * <p>
146 * Specifies the order in which LDIF import plug-ins are to be
147 * loaded and invoked.
148 * <p>
149 * The value is a comma-delimited list of plug-in names (where the
150 * plug-in name is the RDN value from the plug-in configuration entry
151 * DN). The list can include at most one asterisk to indicate the
152 * position of any unspecified plug-in (and the relative order of
153 * those unspecified plug-ins is undefined).
154 *
155 * @return Returns the value of the "plugin-order-ldif-import" property.
156 */
157 String getPluginOrderLDIFImport();
158
159
160
161 /**
162 * Sets the "plugin-order-ldif-import" property.
163 * <p>
164 * Specifies the order in which LDIF import plug-ins are to be
165 * loaded and invoked.
166 * <p>
167 * The value is a comma-delimited list of plug-in names (where the
168 * plug-in name is the RDN value from the plug-in configuration entry
169 * DN). The list can include at most one asterisk to indicate the
170 * position of any unspecified plug-in (and the relative order of
171 * those unspecified plug-ins is undefined).
172 *
173 * @param value The value of the "plugin-order-ldif-import" property.
174 * @throws IllegalPropertyValueException
175 * If the new value is invalid.
176 */
177 void setPluginOrderLDIFImport(String value) throws IllegalPropertyValueException;
178
179
180
181 /**
182 * Gets the "plugin-order-post-connect" property.
183 * <p>
184 * Specifies the order in which post-connect plug-ins are to be
185 * loaded and invoked.
186 * <p>
187 * The value is a comma-delimited list of plug-in names (where the
188 * plug-in name is the RDN value from the plug-in configuration entry
189 * DN). The list can include at most one asterisk to indicate the
190 * position of any unspecified plug-in (and the relative order of
191 * those unspecified plug-ins is undefined).
192 *
193 * @return Returns the value of the "plugin-order-post-connect" property.
194 */
195 String getPluginOrderPostConnect();
196
197
198
199 /**
200 * Sets the "plugin-order-post-connect" property.
201 * <p>
202 * Specifies the order in which post-connect plug-ins are to be
203 * loaded and invoked.
204 * <p>
205 * The value is a comma-delimited list of plug-in names (where the
206 * plug-in name is the RDN value from the plug-in configuration entry
207 * DN). The list can include at most one asterisk to indicate the
208 * position of any unspecified plug-in (and the relative order of
209 * those unspecified plug-ins is undefined).
210 *
211 * @param value The value of the "plugin-order-post-connect" property.
212 * @throws IllegalPropertyValueException
213 * If the new value is invalid.
214 */
215 void setPluginOrderPostConnect(String value) throws IllegalPropertyValueException;
216
217
218
219 /**
220 * Gets the "plugin-order-post-disconnect" property.
221 * <p>
222 * Specifies the order in which post-disconnect plug-ins are to be
223 * loaded and invoked.
224 * <p>
225 * The value is a comma-delimited list of plug-in names (where the
226 * plug-in name is the RDN value from the plug-in configuration entry
227 * DN). The list can include at most one asterisk to indicate the
228 * position of any unspecified plug-in (and the relative order of
229 * those unspecified plug-ins is undefined).
230 *
231 * @return Returns the value of the "plugin-order-post-disconnect" property.
232 */
233 String getPluginOrderPostDisconnect();
234
235
236
237 /**
238 * Sets the "plugin-order-post-disconnect" property.
239 * <p>
240 * Specifies the order in which post-disconnect plug-ins are to be
241 * loaded and invoked.
242 * <p>
243 * The value is a comma-delimited list of plug-in names (where the
244 * plug-in name is the RDN value from the plug-in configuration entry
245 * DN). The list can include at most one asterisk to indicate the
246 * position of any unspecified plug-in (and the relative order of
247 * those unspecified plug-ins is undefined).
248 *
249 * @param value The value of the "plugin-order-post-disconnect" property.
250 * @throws IllegalPropertyValueException
251 * If the new value is invalid.
252 */
253 void setPluginOrderPostDisconnect(String value) throws IllegalPropertyValueException;
254
255
256
257 /**
258 * Gets the "plugin-order-post-operation-abandon" property.
259 * <p>
260 * Specifies the order in which post-operation abandon plug-ins are
261 * to be loaded and invoked.
262 * <p>
263 * The value is a comma-delimited list of plug-in names (where the
264 * plug-in name is the RDN value from the plug-in configuration entry
265 * DN). The list can include at most one asterisk to indicate the
266 * position of any unspecified plug-in (and the relative order of
267 * those unspecified plug-ins is undefined).
268 *
269 * @return Returns the value of the "plugin-order-post-operation-abandon" property.
270 */
271 String getPluginOrderPostOperationAbandon();
272
273
274
275 /**
276 * Sets the "plugin-order-post-operation-abandon" property.
277 * <p>
278 * Specifies the order in which post-operation abandon plug-ins are
279 * to be loaded and invoked.
280 * <p>
281 * The value is a comma-delimited list of plug-in names (where the
282 * plug-in name is the RDN value from the plug-in configuration entry
283 * DN). The list can include at most one asterisk to indicate the
284 * position of any unspecified plug-in (and the relative order of
285 * those unspecified plug-ins is undefined).
286 *
287 * @param value The value of the "plugin-order-post-operation-abandon" property.
288 * @throws IllegalPropertyValueException
289 * If the new value is invalid.
290 */
291 void setPluginOrderPostOperationAbandon(String value) throws IllegalPropertyValueException;
292
293
294
295 /**
296 * Gets the "plugin-order-post-operation-add" property.
297 * <p>
298 * Specifies the order in which post-operation add plug-ins are to
299 * be loaded and invoked.
300 * <p>
301 * The value is a comma-delimited list of plug-in names (where the
302 * plug-in name is the RDN value from the plug-in configuration entry
303 * DN). The list can include at most one asterisk to indicate the
304 * position of any unspecified plug-in (and the relative order of
305 * those unspecified plug-ins is undefined).
306 *
307 * @return Returns the value of the "plugin-order-post-operation-add" property.
308 */
309 String getPluginOrderPostOperationAdd();
310
311
312
313 /**
314 * Sets the "plugin-order-post-operation-add" property.
315 * <p>
316 * Specifies the order in which post-operation add plug-ins are to
317 * be loaded and invoked.
318 * <p>
319 * The value is a comma-delimited list of plug-in names (where the
320 * plug-in name is the RDN value from the plug-in configuration entry
321 * DN). The list can include at most one asterisk to indicate the
322 * position of any unspecified plug-in (and the relative order of
323 * those unspecified plug-ins is undefined).
324 *
325 * @param value The value of the "plugin-order-post-operation-add" property.
326 * @throws IllegalPropertyValueException
327 * If the new value is invalid.
328 */
329 void setPluginOrderPostOperationAdd(String value) throws IllegalPropertyValueException;
330
331
332
333 /**
334 * Gets the "plugin-order-post-operation-bind" property.
335 * <p>
336 * Specifies the order in which post-operation bind plug-ins are to
337 * be loaded and invoked.
338 * <p>
339 * The value is a comma-delimited list of plug-in names (where the
340 * plug-in name is the RDN value from the plug-in configuration entry
341 * DN). The list can include at most one asterisk to indicate the
342 * position of any unspecified plug-in (and the relative order of
343 * those unspecified plug-ins is undefined).
344 *
345 * @return Returns the value of the "plugin-order-post-operation-bind" property.
346 */
347 String getPluginOrderPostOperationBind();
348
349
350
351 /**
352 * Sets the "plugin-order-post-operation-bind" property.
353 * <p>
354 * Specifies the order in which post-operation bind plug-ins are to
355 * be loaded and invoked.
356 * <p>
357 * The value is a comma-delimited list of plug-in names (where the
358 * plug-in name is the RDN value from the plug-in configuration entry
359 * DN). The list can include at most one asterisk to indicate the
360 * position of any unspecified plug-in (and the relative order of
361 * those unspecified plug-ins is undefined).
362 *
363 * @param value The value of the "plugin-order-post-operation-bind" property.
364 * @throws IllegalPropertyValueException
365 * If the new value is invalid.
366 */
367 void setPluginOrderPostOperationBind(String value) throws IllegalPropertyValueException;
368
369
370
371 /**
372 * Gets the "plugin-order-post-operation-compare" property.
373 * <p>
374 * Specifies the order in which post-operation compare plug-ins are
375 * to be loaded and invoked.
376 * <p>
377 * The value is a comma-delimited list of plug-in names (where the
378 * plug-in name is the RDN value from the plug-in configuration entry
379 * DN). The list can include at most one asterisk to indicate the
380 * position of any unspecified plug-in (and the relative order of
381 * those unspecified plug-ins is undefined).
382 *
383 * @return Returns the value of the "plugin-order-post-operation-compare" property.
384 */
385 String getPluginOrderPostOperationCompare();
386
387
388
389 /**
390 * Sets the "plugin-order-post-operation-compare" property.
391 * <p>
392 * Specifies the order in which post-operation compare plug-ins are
393 * to be loaded and invoked.
394 * <p>
395 * The value is a comma-delimited list of plug-in names (where the
396 * plug-in name is the RDN value from the plug-in configuration entry
397 * DN). The list can include at most one asterisk to indicate the
398 * position of any unspecified plug-in (and the relative order of
399 * those unspecified plug-ins is undefined).
400 *
401 * @param value The value of the "plugin-order-post-operation-compare" property.
402 * @throws IllegalPropertyValueException
403 * If the new value is invalid.
404 */
405 void setPluginOrderPostOperationCompare(String value) throws IllegalPropertyValueException;
406
407
408
409 /**
410 * Gets the "plugin-order-post-operation-delete" property.
411 * <p>
412 * Specifies the order in which post-operation delete plug-ins are
413 * to be loaded and invoked.
414 * <p>
415 * The value is a comma-delimited list of plug-in names (where the
416 * plug-in name is the RDN value from the plug-in configuration entry
417 * DN). The list can include at most one asterisk to indicate the
418 * position of any unspecified plug-in (and the relative order of
419 * those unspecified plug-ins is undefined).
420 *
421 * @return Returns the value of the "plugin-order-post-operation-delete" property.
422 */
423 String getPluginOrderPostOperationDelete();
424
425
426
427 /**
428 * Sets the "plugin-order-post-operation-delete" property.
429 * <p>
430 * Specifies the order in which post-operation delete plug-ins are
431 * to be loaded and invoked.
432 * <p>
433 * The value is a comma-delimited list of plug-in names (where the
434 * plug-in name is the RDN value from the plug-in configuration entry
435 * DN). The list can include at most one asterisk to indicate the
436 * position of any unspecified plug-in (and the relative order of
437 * those unspecified plug-ins is undefined).
438 *
439 * @param value The value of the "plugin-order-post-operation-delete" property.
440 * @throws IllegalPropertyValueException
441 * If the new value is invalid.
442 */
443 void setPluginOrderPostOperationDelete(String value) throws IllegalPropertyValueException;
444
445
446
447 /**
448 * Gets the "plugin-order-post-operation-extended" property.
449 * <p>
450 * Specifies the order in which post-operation extended operation
451 * plug-ins are to be loaded and invoked.
452 * <p>
453 * The value is a comma-delimited list of plug-in names (where the
454 * plug-in name is the RDN value from the plug-in configuration entry
455 * DN). The list can include at most one asterisk to indicate the
456 * position of any unspecified plug-in (and the relative order of
457 * those unspecified plug-ins is undefined).
458 *
459 * @return Returns the value of the "plugin-order-post-operation-extended" property.
460 */
461 String getPluginOrderPostOperationExtended();
462
463
464
465 /**
466 * Sets the "plugin-order-post-operation-extended" property.
467 * <p>
468 * Specifies the order in which post-operation extended operation
469 * plug-ins are to be loaded and invoked.
470 * <p>
471 * The value is a comma-delimited list of plug-in names (where the
472 * plug-in name is the RDN value from the plug-in configuration entry
473 * DN). The list can include at most one asterisk to indicate the
474 * position of any unspecified plug-in (and the relative order of
475 * those unspecified plug-ins is undefined).
476 *
477 * @param value The value of the "plugin-order-post-operation-extended" property.
478 * @throws IllegalPropertyValueException
479 * If the new value is invalid.
480 */
481 void setPluginOrderPostOperationExtended(String value) throws IllegalPropertyValueException;
482
483
484
485 /**
486 * Gets the "plugin-order-post-operation-modify" property.
487 * <p>
488 * Specifies the order in which post-operation modify plug-ins are
489 * to be loaded and invoked.
490 * <p>
491 * The value is a comma-delimited list of plug-in names (where the
492 * plug-in name is the RDN value from the plug-in configuration entry
493 * DN). The list can include at most one asterisk to indicate the
494 * position of any unspecified plug-in (and the relative order of
495 * those unspecified plug-ins is undefined).
496 *
497 * @return Returns the value of the "plugin-order-post-operation-modify" property.
498 */
499 String getPluginOrderPostOperationModify();
500
501
502
503 /**
504 * Sets the "plugin-order-post-operation-modify" property.
505 * <p>
506 * Specifies the order in which post-operation modify plug-ins are
507 * to be loaded and invoked.
508 * <p>
509 * The value is a comma-delimited list of plug-in names (where the
510 * plug-in name is the RDN value from the plug-in configuration entry
511 * DN). The list can include at most one asterisk to indicate the
512 * position of any unspecified plug-in (and the relative order of
513 * those unspecified plug-ins is undefined).
514 *
515 * @param value The value of the "plugin-order-post-operation-modify" property.
516 * @throws IllegalPropertyValueException
517 * If the new value is invalid.
518 */
519 void setPluginOrderPostOperationModify(String value) throws IllegalPropertyValueException;
520
521
522
523 /**
524 * Gets the "plugin-order-post-operation-modify-dn" property.
525 * <p>
526 * Specifies the order in which post-operation modify DN plug-ins
527 * are to be loaded and invoked.
528 * <p>
529 * The value is a comma-delimited list of plug-in names (where the
530 * plug-in name is the RDN value from the plug-in configuration entry
531 * DN). The list can include at most one asterisk to indicate the
532 * position of any unspecified plug-in (and the relative order of
533 * those unspecified plug-ins is undefined).
534 *
535 * @return Returns the value of the "plugin-order-post-operation-modify-dn" property.
536 */
537 String getPluginOrderPostOperationModifyDN();
538
539
540
541 /**
542 * Sets the "plugin-order-post-operation-modify-dn" property.
543 * <p>
544 * Specifies the order in which post-operation modify DN plug-ins
545 * are to be loaded and invoked.
546 * <p>
547 * The value is a comma-delimited list of plug-in names (where the
548 * plug-in name is the RDN value from the plug-in configuration entry
549 * DN). The list can include at most one asterisk to indicate the
550 * position of any unspecified plug-in (and the relative order of
551 * those unspecified plug-ins is undefined).
552 *
553 * @param value The value of the "plugin-order-post-operation-modify-dn" property.
554 * @throws IllegalPropertyValueException
555 * If the new value is invalid.
556 */
557 void setPluginOrderPostOperationModifyDN(String value) throws IllegalPropertyValueException;
558
559
560
561 /**
562 * Gets the "plugin-order-post-operation-search" property.
563 * <p>
564 * Specifies the order in which post-operation search plug-ins are
565 * to be loaded and invoked.
566 * <p>
567 * The value is a comma-delimited list of plug-in names (where the
568 * plug-in name is the RDN value from the plug-in configuration entry
569 * DN). The list can include at most one asterisk to indicate the
570 * position of any unspecified plug-in (and the relative order of
571 * those unspecified plug-ins is undefined).
572 *
573 * @return Returns the value of the "plugin-order-post-operation-search" property.
574 */
575 String getPluginOrderPostOperationSearch();
576
577
578
579 /**
580 * Sets the "plugin-order-post-operation-search" property.
581 * <p>
582 * Specifies the order in which post-operation search plug-ins are
583 * to be loaded and invoked.
584 * <p>
585 * The value is a comma-delimited list of plug-in names (where the
586 * plug-in name is the RDN value from the plug-in configuration entry
587 * DN). The list can include at most one asterisk to indicate the
588 * position of any unspecified plug-in (and the relative order of
589 * those unspecified plug-ins is undefined).
590 *
591 * @param value The value of the "plugin-order-post-operation-search" property.
592 * @throws IllegalPropertyValueException
593 * If the new value is invalid.
594 */
595 void setPluginOrderPostOperationSearch(String value) throws IllegalPropertyValueException;
596
597
598
599 /**
600 * Gets the "plugin-order-post-operation-unbind" property.
601 * <p>
602 * Specifies the order in which post-operation unbind plug-ins are
603 * to be loaded and invoked.
604 * <p>
605 * The value is a comma-delimited list of plug-in names (where the
606 * plug-in name is the RDN value from the plug-in configuration entry
607 * DN). The list can include at most one asterisk to indicate the
608 * position of any unspecified plug-in (and the relative order of
609 * those unspecified plug-ins is undefined).
610 *
611 * @return Returns the value of the "plugin-order-post-operation-unbind" property.
612 */
613 String getPluginOrderPostOperationUnbind();
614
615
616
617 /**
618 * Sets the "plugin-order-post-operation-unbind" property.
619 * <p>
620 * Specifies the order in which post-operation unbind plug-ins are
621 * to be loaded and invoked.
622 * <p>
623 * The value is a comma-delimited list of plug-in names (where the
624 * plug-in name is the RDN value from the plug-in configuration entry
625 * DN). The list can include at most one asterisk to indicate the
626 * position of any unspecified plug-in (and the relative order of
627 * those unspecified plug-ins is undefined).
628 *
629 * @param value The value of the "plugin-order-post-operation-unbind" property.
630 * @throws IllegalPropertyValueException
631 * If the new value is invalid.
632 */
633 void setPluginOrderPostOperationUnbind(String value) throws IllegalPropertyValueException;
634
635
636
637 /**
638 * Gets the "plugin-order-post-response-add" property.
639 * <p>
640 * Specifies the order in which post-response add plug-ins are to be
641 * loaded and invoked.
642 * <p>
643 * The value is a comma-delimited list of plug-in names (where the
644 * plug-in name is the RDN value from the plug-in configuration entry
645 * DN). The list can include at most one asterisk to indicate the
646 * position of any unspecified plug-in (and the relative order of
647 * those unspecified plug-ins is undefined).
648 *
649 * @return Returns the value of the "plugin-order-post-response-add" property.
650 */
651 String getPluginOrderPostResponseAdd();
652
653
654
655 /**
656 * Sets the "plugin-order-post-response-add" property.
657 * <p>
658 * Specifies the order in which post-response add plug-ins are to be
659 * loaded and invoked.
660 * <p>
661 * The value is a comma-delimited list of plug-in names (where the
662 * plug-in name is the RDN value from the plug-in configuration entry
663 * DN). The list can include at most one asterisk to indicate the
664 * position of any unspecified plug-in (and the relative order of
665 * those unspecified plug-ins is undefined).
666 *
667 * @param value The value of the "plugin-order-post-response-add" property.
668 * @throws IllegalPropertyValueException
669 * If the new value is invalid.
670 */
671 void setPluginOrderPostResponseAdd(String value) throws IllegalPropertyValueException;
672
673
674
675 /**
676 * Gets the "plugin-order-post-response-bind" property.
677 * <p>
678 * Specifies the order in which post-response bind plug-ins are to
679 * be loaded and invoked.
680 * <p>
681 * The value is a comma-delimited list of plug-in names (where the
682 * plug-in name is the RDN value from the plug-in configuration entry
683 * DN). The list can include at most one asterisk to indicate the
684 * position of any unspecified plug-in (and the relative order of
685 * those unspecified plug-ins is undefined).
686 *
687 * @return Returns the value of the "plugin-order-post-response-bind" property.
688 */
689 String getPluginOrderPostResponseBind();
690
691
692
693 /**
694 * Sets the "plugin-order-post-response-bind" property.
695 * <p>
696 * Specifies the order in which post-response bind plug-ins are to
697 * be loaded and invoked.
698 * <p>
699 * The value is a comma-delimited list of plug-in names (where the
700 * plug-in name is the RDN value from the plug-in configuration entry
701 * DN). The list can include at most one asterisk to indicate the
702 * position of any unspecified plug-in (and the relative order of
703 * those unspecified plug-ins is undefined).
704 *
705 * @param value The value of the "plugin-order-post-response-bind" property.
706 * @throws IllegalPropertyValueException
707 * If the new value is invalid.
708 */
709 void setPluginOrderPostResponseBind(String value) throws IllegalPropertyValueException;
710
711
712
713 /**
714 * Gets the "plugin-order-post-response-compare" property.
715 * <p>
716 * Specifies the order in which post-response compare plug-ins are
717 * to be loaded and invoked.
718 * <p>
719 * The value is a comma-delimited list of plug-in names (where the
720 * plug-in name is the RDN value from the plug-in configuration entry
721 * DN). The list can include at most one asterisk to indicate the
722 * position of any unspecified plug-in (and the relative order of
723 * those unspecified plug-ins is undefined).
724 *
725 * @return Returns the value of the "plugin-order-post-response-compare" property.
726 */
727 String getPluginOrderPostResponseCompare();
728
729
730
731 /**
732 * Sets the "plugin-order-post-response-compare" property.
733 * <p>
734 * Specifies the order in which post-response compare plug-ins are
735 * to be loaded and invoked.
736 * <p>
737 * The value is a comma-delimited list of plug-in names (where the
738 * plug-in name is the RDN value from the plug-in configuration entry
739 * DN). The list can include at most one asterisk to indicate the
740 * position of any unspecified plug-in (and the relative order of
741 * those unspecified plug-ins is undefined).
742 *
743 * @param value The value of the "plugin-order-post-response-compare" property.
744 * @throws IllegalPropertyValueException
745 * If the new value is invalid.
746 */
747 void setPluginOrderPostResponseCompare(String value) throws IllegalPropertyValueException;
748
749
750
751 /**
752 * Gets the "plugin-order-post-response-delete" property.
753 * <p>
754 * Specifies the order in which post-response delete plug-ins are to
755 * be loaded and invoked.
756 * <p>
757 * The value is a comma-delimited list of plug-in names (where the
758 * plug-in name is the RDN value from the plug-in configuration entry
759 * DN). The list can include at most one asterisk to indicate the
760 * position of any unspecified plug-in (and the relative order of
761 * those unspecified plug-ins is undefined).
762 *
763 * @return Returns the value of the "plugin-order-post-response-delete" property.
764 */
765 String getPluginOrderPostResponseDelete();
766
767
768
769 /**
770 * Sets the "plugin-order-post-response-delete" property.
771 * <p>
772 * Specifies the order in which post-response delete plug-ins are to
773 * be loaded and invoked.
774 * <p>
775 * The value is a comma-delimited list of plug-in names (where the
776 * plug-in name is the RDN value from the plug-in configuration entry
777 * DN). The list can include at most one asterisk to indicate the
778 * position of any unspecified plug-in (and the relative order of
779 * those unspecified plug-ins is undefined).
780 *
781 * @param value The value of the "plugin-order-post-response-delete" property.
782 * @throws IllegalPropertyValueException
783 * If the new value is invalid.
784 */
785 void setPluginOrderPostResponseDelete(String value) throws IllegalPropertyValueException;
786
787
788
789 /**
790 * Gets the "plugin-order-post-response-extended" property.
791 * <p>
792 * Specifies the order in which post-response extended operation
793 * plug-ins are to be loaded and invoked.
794 * <p>
795 * The value is a comma-delimited list of plug-in names (where the
796 * plug-in name is the RDN value from the plug-in configuration entry
797 * DN). The list can include at most one asterisk to indicate the
798 * position of any unspecified plug-in (and the relative order of
799 * those unspecified plug-ins is undefined).
800 *
801 * @return Returns the value of the "plugin-order-post-response-extended" property.
802 */
803 String getPluginOrderPostResponseExtended();
804
805
806
807 /**
808 * Sets the "plugin-order-post-response-extended" property.
809 * <p>
810 * Specifies the order in which post-response extended operation
811 * plug-ins are to be loaded and invoked.
812 * <p>
813 * The value is a comma-delimited list of plug-in names (where the
814 * plug-in name is the RDN value from the plug-in configuration entry
815 * DN). The list can include at most one asterisk to indicate the
816 * position of any unspecified plug-in (and the relative order of
817 * those unspecified plug-ins is undefined).
818 *
819 * @param value The value of the "plugin-order-post-response-extended" property.
820 * @throws IllegalPropertyValueException
821 * If the new value is invalid.
822 */
823 void setPluginOrderPostResponseExtended(String value) throws IllegalPropertyValueException;
824
825
826
827 /**
828 * Gets the "plugin-order-post-response-modify" property.
829 * <p>
830 * Specifies the order in which post-response modify plug-ins are to
831 * be loaded and invoked.
832 * <p>
833 * The value is a comma-delimited list of plug-in names (where the
834 * plug-in name is the RDN value from the plug-in configuration entry
835 * DN). The list can include at most one asterisk to indicate the
836 * position of any unspecified plug-in (and the relative order of
837 * those unspecified plug-ins is undefined).
838 *
839 * @return Returns the value of the "plugin-order-post-response-modify" property.
840 */
841 String getPluginOrderPostResponseModify();
842
843
844
845 /**
846 * Sets the "plugin-order-post-response-modify" property.
847 * <p>
848 * Specifies the order in which post-response modify plug-ins are to
849 * be loaded and invoked.
850 * <p>
851 * The value is a comma-delimited list of plug-in names (where the
852 * plug-in name is the RDN value from the plug-in configuration entry
853 * DN). The list can include at most one asterisk to indicate the
854 * position of any unspecified plug-in (and the relative order of
855 * those unspecified plug-ins is undefined).
856 *
857 * @param value The value of the "plugin-order-post-response-modify" property.
858 * @throws IllegalPropertyValueException
859 * If the new value is invalid.
860 */
861 void setPluginOrderPostResponseModify(String value) throws IllegalPropertyValueException;
862
863
864
865 /**
866 * Gets the "plugin-order-post-response-modify-dn" property.
867 * <p>
868 * Specifies the order in which post-response modify DN plug-ins are
869 * to be loaded and invoked.
870 * <p>
871 * The value is a comma-delimited list of plug-in names (where the
872 * plug-in name is the RDN value from the plug-in configuration entry
873 * DN). The list can include at most one asterisk to indicate the
874 * position of any unspecified plug-in (and the relative order of
875 * those unspecified plug-ins is undefined).
876 *
877 * @return Returns the value of the "plugin-order-post-response-modify-dn" property.
878 */
879 String getPluginOrderPostResponseModifyDN();
880
881
882
883 /**
884 * Sets the "plugin-order-post-response-modify-dn" property.
885 * <p>
886 * Specifies the order in which post-response modify DN plug-ins are
887 * to be loaded and invoked.
888 * <p>
889 * The value is a comma-delimited list of plug-in names (where the
890 * plug-in name is the RDN value from the plug-in configuration entry
891 * DN). The list can include at most one asterisk to indicate the
892 * position of any unspecified plug-in (and the relative order of
893 * those unspecified plug-ins is undefined).
894 *
895 * @param value The value of the "plugin-order-post-response-modify-dn" property.
896 * @throws IllegalPropertyValueException
897 * If the new value is invalid.
898 */
899 void setPluginOrderPostResponseModifyDN(String value) throws IllegalPropertyValueException;
900
901
902
903 /**
904 * Gets the "plugin-order-post-response-search" property.
905 * <p>
906 * Specifies the order in which post-response search plug-ins are to
907 * be loaded and invoked.
908 * <p>
909 * The value is a comma-delimited list of plug-in names (where the
910 * plug-in name is the RDN value from the plug-in configuration entry
911 * DN). The list can include at most one asterisk to indicate the
912 * position of any unspecified plug-in (and the relative order of
913 * those unspecified plug-ins is undefined).
914 *
915 * @return Returns the value of the "plugin-order-post-response-search" property.
916 */
917 String getPluginOrderPostResponseSearch();
918
919
920
921 /**
922 * Sets the "plugin-order-post-response-search" property.
923 * <p>
924 * Specifies the order in which post-response search plug-ins are to
925 * be loaded and invoked.
926 * <p>
927 * The value is a comma-delimited list of plug-in names (where the
928 * plug-in name is the RDN value from the plug-in configuration entry
929 * DN). The list can include at most one asterisk to indicate the
930 * position of any unspecified plug-in (and the relative order of
931 * those unspecified plug-ins is undefined).
932 *
933 * @param value The value of the "plugin-order-post-response-search" property.
934 * @throws IllegalPropertyValueException
935 * If the new value is invalid.
936 */
937 void setPluginOrderPostResponseSearch(String value) throws IllegalPropertyValueException;
938
939
940
941 /**
942 * Gets the "plugin-order-post-synchronization-add" property.
943 * <p>
944 * Specifies the order in which post-synchronization add plug-ins
945 * are to be loaded and invoked.
946 * <p>
947 * The value is a comma-delimited list of plug-in names (where the
948 * plug-in name is the RDN value from the plug-in configuration entry
949 * DN). The list can include at most one asterisk to indicate the
950 * position of any unspecified plug-in (and the relative order of
951 * those unspecified plug-ins is undefined).
952 *
953 * @return Returns the value of the "plugin-order-post-synchronization-add" property.
954 */
955 String getPluginOrderPostSynchronizationAdd();
956
957
958
959 /**
960 * Sets the "plugin-order-post-synchronization-add" property.
961 * <p>
962 * Specifies the order in which post-synchronization add plug-ins
963 * are to be loaded and invoked.
964 * <p>
965 * The value is a comma-delimited list of plug-in names (where the
966 * plug-in name is the RDN value from the plug-in configuration entry
967 * DN). The list can include at most one asterisk to indicate the
968 * position of any unspecified plug-in (and the relative order of
969 * those unspecified plug-ins is undefined).
970 *
971 * @param value The value of the "plugin-order-post-synchronization-add" property.
972 * @throws IllegalPropertyValueException
973 * If the new value is invalid.
974 */
975 void setPluginOrderPostSynchronizationAdd(String value) throws IllegalPropertyValueException;
976
977
978
979 /**
980 * Gets the "plugin-order-post-synchronization-delete" property.
981 * <p>
982 * Specifies the order in which post-synchronization delete plug-ins
983 * are to be loaded and invoked.
984 * <p>
985 * The value is a comma-delimited list of plug-in names (where the
986 * plug-in name is the RDN value from the plug-in configuration entry
987 * DN). The list can include at most one asterisk to indicate the
988 * position of any unspecified plug-in (and the relative order of
989 * those unspecified plug-ins is undefined).
990 *
991 * @return Returns the value of the "plugin-order-post-synchronization-delete" property.
992 */
993 String getPluginOrderPostSynchronizationDelete();
994
995
996
997 /**
998 * Sets the "plugin-order-post-synchronization-delete" property.
999 * <p>
1000 * Specifies the order in which post-synchronization delete plug-ins
1001 * are to be loaded and invoked.
1002 * <p>
1003 * The value is a comma-delimited list of plug-in names (where the
1004 * plug-in name is the RDN value from the plug-in configuration entry
1005 * DN). The list can include at most one asterisk to indicate the
1006 * position of any unspecified plug-in (and the relative order of
1007 * those unspecified plug-ins is undefined).
1008 *
1009 * @param value The value of the "plugin-order-post-synchronization-delete" property.
1010 * @throws IllegalPropertyValueException
1011 * If the new value is invalid.
1012 */
1013 void setPluginOrderPostSynchronizationDelete(String value) throws IllegalPropertyValueException;
1014
1015
1016
1017 /**
1018 * Gets the "plugin-order-post-synchronization-modify" property.
1019 * <p>
1020 * Specifies the order in which post-synchronization modify plug-ins
1021 * are to be loaded and invoked.
1022 * <p>
1023 * The value is a comma-delimited list of plug-in names (where the
1024 * plug-in name is the RDN value from the plug-in configuration entry
1025 * DN). The list can include at most one asterisk to indicate the
1026 * position of any unspecified plug-in (and the relative order of
1027 * those unspecified plug-ins is undefined).
1028 *
1029 * @return Returns the value of the "plugin-order-post-synchronization-modify" property.
1030 */
1031 String getPluginOrderPostSynchronizationModify();
1032
1033
1034
1035 /**
1036 * Sets the "plugin-order-post-synchronization-modify" property.
1037 * <p>
1038 * Specifies the order in which post-synchronization modify plug-ins
1039 * are to be loaded and invoked.
1040 * <p>
1041 * The value is a comma-delimited list of plug-in names (where the
1042 * plug-in name is the RDN value from the plug-in configuration entry
1043 * DN). The list can include at most one asterisk to indicate the
1044 * position of any unspecified plug-in (and the relative order of
1045 * those unspecified plug-ins is undefined).
1046 *
1047 * @param value The value of the "plugin-order-post-synchronization-modify" property.
1048 * @throws IllegalPropertyValueException
1049 * If the new value is invalid.
1050 */
1051 void setPluginOrderPostSynchronizationModify(String value) throws IllegalPropertyValueException;
1052
1053
1054
1055 /**
1056 * Gets the "plugin-order-post-synchronization-modify-dn" property.
1057 * <p>
1058 * Specifies the order in which post-synchronization modify DN
1059 * plug-ins are to be loaded and invoked.
1060 * <p>
1061 * The value is a comma-delimited list of plug-in names (where the
1062 * plug-in name is the RDN value from the plug-in configuration entry
1063 * DN). The list can include at most one asterisk to indicate the
1064 * position of any unspecified plug-in (and the relative order of
1065 * those unspecified plug-ins is undefined).
1066 *
1067 * @return Returns the value of the "plugin-order-post-synchronization-modify-dn" property.
1068 */
1069 String getPluginOrderPostSynchronizationModifyDN();
1070
1071
1072
1073 /**
1074 * Sets the "plugin-order-post-synchronization-modify-dn" property.
1075 * <p>
1076 * Specifies the order in which post-synchronization modify DN
1077 * plug-ins are to be loaded and invoked.
1078 * <p>
1079 * The value is a comma-delimited list of plug-in names (where the
1080 * plug-in name is the RDN value from the plug-in configuration entry
1081 * DN). The list can include at most one asterisk to indicate the
1082 * position of any unspecified plug-in (and the relative order of
1083 * those unspecified plug-ins is undefined).
1084 *
1085 * @param value The value of the "plugin-order-post-synchronization-modify-dn" property.
1086 * @throws IllegalPropertyValueException
1087 * If the new value is invalid.
1088 */
1089 void setPluginOrderPostSynchronizationModifyDN(String value) throws IllegalPropertyValueException;
1090
1091
1092
1093 /**
1094 * Gets the "plugin-order-pre-operation-add" property.
1095 * <p>
1096 * Specifies the order in which pre-operation add plug-ins are to be
1097 * loaded and invoked.
1098 * <p>
1099 * The value is a comma-delimited list of plug-in names (where the
1100 * plug-in name is the RDN value from the plug-in configuration entry
1101 * DN). The list can include at most one asterisk to indicate the
1102 * position of any unspecified plug-in (and the relative order of
1103 * those unspecified plug-ins is undefined).
1104 *
1105 * @return Returns the value of the "plugin-order-pre-operation-add" property.
1106 */
1107 String getPluginOrderPreOperationAdd();
1108
1109
1110
1111 /**
1112 * Sets the "plugin-order-pre-operation-add" property.
1113 * <p>
1114 * Specifies the order in which pre-operation add plug-ins are to be
1115 * loaded and invoked.
1116 * <p>
1117 * The value is a comma-delimited list of plug-in names (where the
1118 * plug-in name is the RDN value from the plug-in configuration entry
1119 * DN). The list can include at most one asterisk to indicate the
1120 * position of any unspecified plug-in (and the relative order of
1121 * those unspecified plug-ins is undefined).
1122 *
1123 * @param value The value of the "plugin-order-pre-operation-add" property.
1124 * @throws IllegalPropertyValueException
1125 * If the new value is invalid.
1126 */
1127 void setPluginOrderPreOperationAdd(String value) throws IllegalPropertyValueException;
1128
1129
1130
1131 /**
1132 * Gets the "plugin-order-pre-operation-bind" property.
1133 * <p>
1134 * Specifies the order in which pre-operation bind plug-ins are to
1135 * be loaded and invoked.
1136 * <p>
1137 * The value is a comma-delimited list of plug-in names (where the
1138 * plug-in name is the RDN value from the plug-in configuration entry
1139 * DN). The list can include at most one asterisk to indicate the
1140 * position of any unspecified plug-in (and the relative order of
1141 * those unspecified plug-ins is undefined).
1142 *
1143 * @return Returns the value of the "plugin-order-pre-operation-bind" property.
1144 */
1145 String getPluginOrderPreOperationBind();
1146
1147
1148
1149 /**
1150 * Sets the "plugin-order-pre-operation-bind" property.
1151 * <p>
1152 * Specifies the order in which pre-operation bind plug-ins are to
1153 * be loaded and invoked.
1154 * <p>
1155 * The value is a comma-delimited list of plug-in names (where the
1156 * plug-in name is the RDN value from the plug-in configuration entry
1157 * DN). The list can include at most one asterisk to indicate the
1158 * position of any unspecified plug-in (and the relative order of
1159 * those unspecified plug-ins is undefined).
1160 *
1161 * @param value The value of the "plugin-order-pre-operation-bind" property.
1162 * @throws IllegalPropertyValueException
1163 * If the new value is invalid.
1164 */
1165 void setPluginOrderPreOperationBind(String value) throws IllegalPropertyValueException;
1166
1167
1168
1169 /**
1170 * Gets the "plugin-order-pre-operation-compare" property.
1171 * <p>
1172 * Specifies the order in which pre-operation compare plug-ins are
1173 * to be loaded and invoked.
1174 * <p>
1175 * The value is a comma-delimited list of plug-in names (where the
1176 * plug-in name is the RDN value from the plug-in configuration entry
1177 * DN). The list can include at most one asterisk to indicate the
1178 * position of any unspecified plug-in (and the relative order of
1179 * those unspecified plug-ins is undefined).
1180 *
1181 * @return Returns the value of the "plugin-order-pre-operation-compare" property.
1182 */
1183 String getPluginOrderPreOperationCompare();
1184
1185
1186
1187 /**
1188 * Sets the "plugin-order-pre-operation-compare" property.
1189 * <p>
1190 * Specifies the order in which pre-operation compare plug-ins are
1191 * to be loaded and invoked.
1192 * <p>
1193 * The value is a comma-delimited list of plug-in names (where the
1194 * plug-in name is the RDN value from the plug-in configuration entry
1195 * DN). The list can include at most one asterisk to indicate the
1196 * position of any unspecified plug-in (and the relative order of
1197 * those unspecified plug-ins is undefined).
1198 *
1199 * @param value The value of the "plugin-order-pre-operation-compare" property.
1200 * @throws IllegalPropertyValueException
1201 * If the new value is invalid.
1202 */
1203 void setPluginOrderPreOperationCompare(String value) throws IllegalPropertyValueException;
1204
1205
1206
1207 /**
1208 * Gets the "plugin-order-pre-operation-delete" property.
1209 * <p>
1210 * Specifies the order in which pre-operation delete plug-ins are to
1211 * be loaded and invoked.
1212 * <p>
1213 * The value is a comma-delimited list of plug-in names (where the
1214 * plug-in name is the RDN value from the plug-in configuration entry
1215 * DN). The list can include at most one asterisk to indicate the
1216 * position of any unspecified plug-in (and the relative order of
1217 * those unspecified plug-ins is undefined).
1218 *
1219 * @return Returns the value of the "plugin-order-pre-operation-delete" property.
1220 */
1221 String getPluginOrderPreOperationDelete();
1222
1223
1224
1225 /**
1226 * Sets the "plugin-order-pre-operation-delete" property.
1227 * <p>
1228 * Specifies the order in which pre-operation delete plug-ins are to
1229 * be loaded and invoked.
1230 * <p>
1231 * The value is a comma-delimited list of plug-in names (where the
1232 * plug-in name is the RDN value from the plug-in configuration entry
1233 * DN). The list can include at most one asterisk to indicate the
1234 * position of any unspecified plug-in (and the relative order of
1235 * those unspecified plug-ins is undefined).
1236 *
1237 * @param value The value of the "plugin-order-pre-operation-delete" property.
1238 * @throws IllegalPropertyValueException
1239 * If the new value is invalid.
1240 */
1241 void setPluginOrderPreOperationDelete(String value) throws IllegalPropertyValueException;
1242
1243
1244
1245 /**
1246 * Gets the "plugin-order-pre-operation-extended" property.
1247 * <p>
1248 * Specifies the order in which pre-operation extended operation
1249 * plug-ins are to be loaded and invoked.
1250 * <p>
1251 * The value is a comma-delimited list of plug-in names (where the
1252 * plug-in name is the RDN value from the plug-in configuration entry
1253 * DN). The list can include at most one asterisk to indicate the
1254 * position of any unspecified plug-in (and the relative order of
1255 * those unspecified plug-ins is undefined).
1256 *
1257 * @return Returns the value of the "plugin-order-pre-operation-extended" property.
1258 */
1259 String getPluginOrderPreOperationExtended();
1260
1261
1262
1263 /**
1264 * Sets the "plugin-order-pre-operation-extended" property.
1265 * <p>
1266 * Specifies the order in which pre-operation extended operation
1267 * plug-ins are to be loaded and invoked.
1268 * <p>
1269 * The value is a comma-delimited list of plug-in names (where the
1270 * plug-in name is the RDN value from the plug-in configuration entry
1271 * DN). The list can include at most one asterisk to indicate the
1272 * position of any unspecified plug-in (and the relative order of
1273 * those unspecified plug-ins is undefined).
1274 *
1275 * @param value The value of the "plugin-order-pre-operation-extended" property.
1276 * @throws IllegalPropertyValueException
1277 * If the new value is invalid.
1278 */
1279 void setPluginOrderPreOperationExtended(String value) throws IllegalPropertyValueException;
1280
1281
1282
1283 /**
1284 * Gets the "plugin-order-pre-operation-modify" property.
1285 * <p>
1286 * Specifies the order in which pre-operation modify plug-ins are to
1287 * be loaded and invoked.
1288 * <p>
1289 * The value is a comma-delimited list of plug-in names (where the
1290 * plug-in name is the RDN value from the plug-in configuration entry
1291 * DN). The list can include at most one asterisk to indicate the
1292 * position of any unspecified plug-in (and the relative order of
1293 * those unspecified plug-ins is undefined).
1294 *
1295 * @return Returns the value of the "plugin-order-pre-operation-modify" property.
1296 */
1297 String getPluginOrderPreOperationModify();
1298
1299
1300
1301 /**
1302 * Sets the "plugin-order-pre-operation-modify" property.
1303 * <p>
1304 * Specifies the order in which pre-operation modify plug-ins are to
1305 * be loaded and invoked.
1306 * <p>
1307 * The value is a comma-delimited list of plug-in names (where the
1308 * plug-in name is the RDN value from the plug-in configuration entry
1309 * DN). The list can include at most one asterisk to indicate the
1310 * position of any unspecified plug-in (and the relative order of
1311 * those unspecified plug-ins is undefined).
1312 *
1313 * @param value The value of the "plugin-order-pre-operation-modify" property.
1314 * @throws IllegalPropertyValueException
1315 * If the new value is invalid.
1316 */
1317 void setPluginOrderPreOperationModify(String value) throws IllegalPropertyValueException;
1318
1319
1320
1321 /**
1322 * Gets the "plugin-order-pre-operation-modify-dn" property.
1323 * <p>
1324 * Specifies the order in which pre-operation modify DN plug-ins are
1325 * to be loaded and invoked.
1326 * <p>
1327 * The value is a comma-delimited list of plug-in names (where the
1328 * plug-in name is the RDN value from the plug-in configuration entry
1329 * DN). The list can include at most one asterisk to indicate the
1330 * position of any unspecified plug-in (and the relative order of
1331 * those unspecified plug-ins is undefined).
1332 *
1333 * @return Returns the value of the "plugin-order-pre-operation-modify-dn" property.
1334 */
1335 String getPluginOrderPreOperationModifyDN();
1336
1337
1338
1339 /**
1340 * Sets the "plugin-order-pre-operation-modify-dn" property.
1341 * <p>
1342 * Specifies the order in which pre-operation modify DN plug-ins are
1343 * to be loaded and invoked.
1344 * <p>
1345 * The value is a comma-delimited list of plug-in names (where the
1346 * plug-in name is the RDN value from the plug-in configuration entry
1347 * DN). The list can include at most one asterisk to indicate the
1348 * position of any unspecified plug-in (and the relative order of
1349 * those unspecified plug-ins is undefined).
1350 *
1351 * @param value The value of the "plugin-order-pre-operation-modify-dn" property.
1352 * @throws IllegalPropertyValueException
1353 * If the new value is invalid.
1354 */
1355 void setPluginOrderPreOperationModifyDN(String value) throws IllegalPropertyValueException;
1356
1357
1358
1359 /**
1360 * Gets the "plugin-order-pre-operation-search" property.
1361 * <p>
1362 * Specifies the order in which pre-operation search plug-ins are to
1363 * be loaded and invoked.
1364 * <p>
1365 * The value is a comma-delimited list of plug-in names (where the
1366 * plug-in name is the RDN value from the plug-in configuration entry
1367 * DN). The list can include at most one asterisk to indicate the
1368 * position of any unspecified plug-in (and the relative order of
1369 * those unspecified plug-ins is undefined).
1370 *
1371 * @return Returns the value of the "plugin-order-pre-operation-search" property.
1372 */
1373 String getPluginOrderPreOperationSearch();
1374
1375
1376
1377 /**
1378 * Sets the "plugin-order-pre-operation-search" property.
1379 * <p>
1380 * Specifies the order in which pre-operation search plug-ins are to
1381 * be loaded and invoked.
1382 * <p>
1383 * The value is a comma-delimited list of plug-in names (where the
1384 * plug-in name is the RDN value from the plug-in configuration entry
1385 * DN). The list can include at most one asterisk to indicate the
1386 * position of any unspecified plug-in (and the relative order of
1387 * those unspecified plug-ins is undefined).
1388 *
1389 * @param value The value of the "plugin-order-pre-operation-search" property.
1390 * @throws IllegalPropertyValueException
1391 * If the new value is invalid.
1392 */
1393 void setPluginOrderPreOperationSearch(String value) throws IllegalPropertyValueException;
1394
1395
1396
1397 /**
1398 * Gets the "plugin-order-pre-parse-abandon" property.
1399 * <p>
1400 * Specifies the order in which pre-parse abandon plug-ins are to be
1401 * loaded and invoked.
1402 * <p>
1403 * The value is a comma-delimited list of plug-in names (where the
1404 * plug-in name is the RDN value from the plug-in configuration entry
1405 * DN). The list can include at most one asterisk to indicate the
1406 * position of any unspecified plug-in (and the relative order of
1407 * those unspecified plug-ins is undefined).
1408 *
1409 * @return Returns the value of the "plugin-order-pre-parse-abandon" property.
1410 */
1411 String getPluginOrderPreParseAbandon();
1412
1413
1414
1415 /**
1416 * Sets the "plugin-order-pre-parse-abandon" property.
1417 * <p>
1418 * Specifies the order in which pre-parse abandon plug-ins are to be
1419 * loaded and invoked.
1420 * <p>
1421 * The value is a comma-delimited list of plug-in names (where the
1422 * plug-in name is the RDN value from the plug-in configuration entry
1423 * DN). The list can include at most one asterisk to indicate the
1424 * position of any unspecified plug-in (and the relative order of
1425 * those unspecified plug-ins is undefined).
1426 *
1427 * @param value The value of the "plugin-order-pre-parse-abandon" property.
1428 * @throws IllegalPropertyValueException
1429 * If the new value is invalid.
1430 */
1431 void setPluginOrderPreParseAbandon(String value) throws IllegalPropertyValueException;
1432
1433
1434
1435 /**
1436 * Gets the "plugin-order-pre-parse-add" property.
1437 * <p>
1438 * Specifies the order in which pre-parse add plug-ins are to be
1439 * loaded and invoked.
1440 * <p>
1441 * The value is a comma-delimited list of plug-in names (where the
1442 * plug-in name is the RDN value from the plug-in configuration entry
1443 * DN). The list can include at most one asterisk to indicate the
1444 * position of any unspecified plug-in (and the relative order of
1445 * those unspecified plug-ins is undefined).
1446 *
1447 * @return Returns the value of the "plugin-order-pre-parse-add" property.
1448 */
1449 String getPluginOrderPreParseAdd();
1450
1451
1452
1453 /**
1454 * Sets the "plugin-order-pre-parse-add" property.
1455 * <p>
1456 * Specifies the order in which pre-parse add plug-ins are to be
1457 * loaded and invoked.
1458 * <p>
1459 * The value is a comma-delimited list of plug-in names (where the
1460 * plug-in name is the RDN value from the plug-in configuration entry
1461 * DN). The list can include at most one asterisk to indicate the
1462 * position of any unspecified plug-in (and the relative order of
1463 * those unspecified plug-ins is undefined).
1464 *
1465 * @param value The value of the "plugin-order-pre-parse-add" property.
1466 * @throws IllegalPropertyValueException
1467 * If the new value is invalid.
1468 */
1469 void setPluginOrderPreParseAdd(String value) throws IllegalPropertyValueException;
1470
1471
1472
1473 /**
1474 * Gets the "plugin-order-pre-parse-bind" property.
1475 * <p>
1476 * Specifies the order in which pre-parse bind plug-ins are to be
1477 * loaded and invoked.
1478 * <p>
1479 * The value is a comma-delimited list of plug-in names (where the
1480 * plug-in name is the RDN value from the plug-in configuration entry
1481 * DN). The list can include at most one asterisk to indicate the
1482 * position of any unspecified plug-in (and the relative order of
1483 * those unspecified plug-ins is undefined).
1484 *
1485 * @return Returns the value of the "plugin-order-pre-parse-bind" property.
1486 */
1487 String getPluginOrderPreParseBind();
1488
1489
1490
1491 /**
1492 * Sets the "plugin-order-pre-parse-bind" property.
1493 * <p>
1494 * Specifies the order in which pre-parse bind plug-ins are to be
1495 * loaded and invoked.
1496 * <p>
1497 * The value is a comma-delimited list of plug-in names (where the
1498 * plug-in name is the RDN value from the plug-in configuration entry
1499 * DN). The list can include at most one asterisk to indicate the
1500 * position of any unspecified plug-in (and the relative order of
1501 * those unspecified plug-ins is undefined).
1502 *
1503 * @param value The value of the "plugin-order-pre-parse-bind" property.
1504 * @throws IllegalPropertyValueException
1505 * If the new value is invalid.
1506 */
1507 void setPluginOrderPreParseBind(String value) throws IllegalPropertyValueException;
1508
1509
1510
1511 /**
1512 * Gets the "plugin-order-pre-parse-compare" property.
1513 * <p>
1514 * Specifies the order in which pre-parse compare plug-ins are to be
1515 * loaded and invoked.
1516 * <p>
1517 * The value is a comma-delimited list of plug-in names (where the
1518 * plug-in name is the RDN value from the plug-in configuration entry
1519 * DN). The list can include at most one asterisk to indicate the
1520 * position of any unspecified plug-in (and the relative order of
1521 * those unspecified plug-ins is undefined).
1522 *
1523 * @return Returns the value of the "plugin-order-pre-parse-compare" property.
1524 */
1525 String getPluginOrderPreParseCompare();
1526
1527
1528
1529 /**
1530 * Sets the "plugin-order-pre-parse-compare" property.
1531 * <p>
1532 * Specifies the order in which pre-parse compare plug-ins are to be
1533 * loaded and invoked.
1534 * <p>
1535 * The value is a comma-delimited list of plug-in names (where the
1536 * plug-in name is the RDN value from the plug-in configuration entry
1537 * DN). The list can include at most one asterisk to indicate the
1538 * position of any unspecified plug-in (and the relative order of
1539 * those unspecified plug-ins is undefined).
1540 *
1541 * @param value The value of the "plugin-order-pre-parse-compare" property.
1542 * @throws IllegalPropertyValueException
1543 * If the new value is invalid.
1544 */
1545 void setPluginOrderPreParseCompare(String value) throws IllegalPropertyValueException;
1546
1547
1548
1549 /**
1550 * Gets the "plugin-order-pre-parse-delete" property.
1551 * <p>
1552 * Specifies the order in which pre-parse delete plug-ins are to be
1553 * loaded and invoked.
1554 * <p>
1555 * The value is a comma-delimited list of plug-in names (where the
1556 * plug-in name is the RDN value from the plug-in configuration entry
1557 * DN). The list can include at most one asterisk to indicate the
1558 * position of any unspecified plug-in (and the relative order of
1559 * those unspecified plug-ins is undefined).
1560 *
1561 * @return Returns the value of the "plugin-order-pre-parse-delete" property.
1562 */
1563 String getPluginOrderPreParseDelete();
1564
1565
1566
1567 /**
1568 * Sets the "plugin-order-pre-parse-delete" property.
1569 * <p>
1570 * Specifies the order in which pre-parse delete plug-ins are to be
1571 * loaded and invoked.
1572 * <p>
1573 * The value is a comma-delimited list of plug-in names (where the
1574 * plug-in name is the RDN value from the plug-in configuration entry
1575 * DN). The list can include at most one asterisk to indicate the
1576 * position of any unspecified plug-in (and the relative order of
1577 * those unspecified plug-ins is undefined).
1578 *
1579 * @param value The value of the "plugin-order-pre-parse-delete" property.
1580 * @throws IllegalPropertyValueException
1581 * If the new value is invalid.
1582 */
1583 void setPluginOrderPreParseDelete(String value) throws IllegalPropertyValueException;
1584
1585
1586
1587 /**
1588 * Gets the "plugin-order-pre-parse-extended" property.
1589 * <p>
1590 * Specifies the order in which pre-parse extended operation
1591 * plug-ins are to be loaded and invoked.
1592 * <p>
1593 * The value is a comma-delimited list of plug-in names (where the
1594 * plug-in name is the RDN value from the plug-in configuration entry
1595 * DN). The list can include at most one asterisk to indicate the
1596 * position of any unspecified plug-in (and the relative order of
1597 * those unspecified plug-ins is undefined).
1598 *
1599 * @return Returns the value of the "plugin-order-pre-parse-extended" property.
1600 */
1601 String getPluginOrderPreParseExtended();
1602
1603
1604
1605 /**
1606 * Sets the "plugin-order-pre-parse-extended" property.
1607 * <p>
1608 * Specifies the order in which pre-parse extended operation
1609 * plug-ins are to be loaded and invoked.
1610 * <p>
1611 * The value is a comma-delimited list of plug-in names (where the
1612 * plug-in name is the RDN value from the plug-in configuration entry
1613 * DN). The list can include at most one asterisk to indicate the
1614 * position of any unspecified plug-in (and the relative order of
1615 * those unspecified plug-ins is undefined).
1616 *
1617 * @param value The value of the "plugin-order-pre-parse-extended" property.
1618 * @throws IllegalPropertyValueException
1619 * If the new value is invalid.
1620 */
1621 void setPluginOrderPreParseExtended(String value) throws IllegalPropertyValueException;
1622
1623
1624
1625 /**
1626 * Gets the "plugin-order-pre-parse-modify" property.
1627 * <p>
1628 * Specifies the order in which pre-parse modify plug-ins are to be
1629 * loaded and invoked.
1630 * <p>
1631 * The value is a comma-delimited list of plug-in names (where the
1632 * plug-in name is the RDN value from the plug-in configuration entry
1633 * DN). The list can include at most one asterisk to indicate the
1634 * position of any unspecified plug-in (and the relative order of
1635 * those unspecified plug-ins is undefined).
1636 *
1637 * @return Returns the value of the "plugin-order-pre-parse-modify" property.
1638 */
1639 String getPluginOrderPreParseModify();
1640
1641
1642
1643 /**
1644 * Sets the "plugin-order-pre-parse-modify" property.
1645 * <p>
1646 * Specifies the order in which pre-parse modify plug-ins are to be
1647 * loaded and invoked.
1648 * <p>
1649 * The value is a comma-delimited list of plug-in names (where the
1650 * plug-in name is the RDN value from the plug-in configuration entry
1651 * DN). The list can include at most one asterisk to indicate the
1652 * position of any unspecified plug-in (and the relative order of
1653 * those unspecified plug-ins is undefined).
1654 *
1655 * @param value The value of the "plugin-order-pre-parse-modify" property.
1656 * @throws IllegalPropertyValueException
1657 * If the new value is invalid.
1658 */
1659 void setPluginOrderPreParseModify(String value) throws IllegalPropertyValueException;
1660
1661
1662
1663 /**
1664 * Gets the "plugin-order-pre-parse-modify-dn" property.
1665 * <p>
1666 * Specifies the order in which pre-parse modify DN plug-ins are to
1667 * be loaded and invoked.
1668 * <p>
1669 * The value is a comma-delimited list of plug-in names (where the
1670 * plug-in name is the RDN value from the plug-in configuration entry
1671 * DN). The list can include at most one asterisk to indicate the
1672 * position of any unspecified plug-in (and the relative order of
1673 * those unspecified plug-ins is undefined).
1674 *
1675 * @return Returns the value of the "plugin-order-pre-parse-modify-dn" property.
1676 */
1677 String getPluginOrderPreParseModifyDN();
1678
1679
1680
1681 /**
1682 * Sets the "plugin-order-pre-parse-modify-dn" property.
1683 * <p>
1684 * Specifies the order in which pre-parse modify DN plug-ins are to
1685 * be loaded and invoked.
1686 * <p>
1687 * The value is a comma-delimited list of plug-in names (where the
1688 * plug-in name is the RDN value from the plug-in configuration entry
1689 * DN). The list can include at most one asterisk to indicate the
1690 * position of any unspecified plug-in (and the relative order of
1691 * those unspecified plug-ins is undefined).
1692 *
1693 * @param value The value of the "plugin-order-pre-parse-modify-dn" property.
1694 * @throws IllegalPropertyValueException
1695 * If the new value is invalid.
1696 */
1697 void setPluginOrderPreParseModifyDN(String value) throws IllegalPropertyValueException;
1698
1699
1700
1701 /**
1702 * Gets the "plugin-order-pre-parse-search" property.
1703 * <p>
1704 * Specifies the order in which pre-parse search plug-ins are to be
1705 * loaded and invoked.
1706 * <p>
1707 * The value is a comma-delimited list of plug-in names (where the
1708 * plug-in name is the RDN value from the plug-in configuration entry
1709 * DN). The list can include at most one asterisk to indicate the
1710 * position of any unspecified plug-in (and the relative order of
1711 * those unspecified plug-ins is undefined).
1712 *
1713 * @return Returns the value of the "plugin-order-pre-parse-search" property.
1714 */
1715 String getPluginOrderPreParseSearch();
1716
1717
1718
1719 /**
1720 * Sets the "plugin-order-pre-parse-search" property.
1721 * <p>
1722 * Specifies the order in which pre-parse search plug-ins are to be
1723 * loaded and invoked.
1724 * <p>
1725 * The value is a comma-delimited list of plug-in names (where the
1726 * plug-in name is the RDN value from the plug-in configuration entry
1727 * DN). The list can include at most one asterisk to indicate the
1728 * position of any unspecified plug-in (and the relative order of
1729 * those unspecified plug-ins is undefined).
1730 *
1731 * @param value The value of the "plugin-order-pre-parse-search" property.
1732 * @throws IllegalPropertyValueException
1733 * If the new value is invalid.
1734 */
1735 void setPluginOrderPreParseSearch(String value) throws IllegalPropertyValueException;
1736
1737
1738
1739 /**
1740 * Gets the "plugin-order-pre-parse-unbind" property.
1741 * <p>
1742 * Specifies the order in which pre-parse unbind plug-ins are to be
1743 * loaded and invoked.
1744 * <p>
1745 * The value is a comma-delimited list of plug-in names (where the
1746 * plug-in name is the RDN value from the plug-in configuration entry
1747 * DN). The list can include at most one asterisk to indicate the
1748 * position of any unspecified plug-in (and the relative order of
1749 * those unspecified plug-ins is undefined).
1750 *
1751 * @return Returns the value of the "plugin-order-pre-parse-unbind" property.
1752 */
1753 String getPluginOrderPreParseUnbind();
1754
1755
1756
1757 /**
1758 * Sets the "plugin-order-pre-parse-unbind" property.
1759 * <p>
1760 * Specifies the order in which pre-parse unbind plug-ins are to be
1761 * loaded and invoked.
1762 * <p>
1763 * The value is a comma-delimited list of plug-in names (where the
1764 * plug-in name is the RDN value from the plug-in configuration entry
1765 * DN). The list can include at most one asterisk to indicate the
1766 * position of any unspecified plug-in (and the relative order of
1767 * those unspecified plug-ins is undefined).
1768 *
1769 * @param value The value of the "plugin-order-pre-parse-unbind" property.
1770 * @throws IllegalPropertyValueException
1771 * If the new value is invalid.
1772 */
1773 void setPluginOrderPreParseUnbind(String value) throws IllegalPropertyValueException;
1774
1775
1776
1777 /**
1778 * Gets the "plugin-order-search-result-entry" property.
1779 * <p>
1780 * Specifies the order in which search result entry plug-ins are to
1781 * be loaded and invoked.
1782 * <p>
1783 * The value is a comma-delimited list of plug-in names (where the
1784 * plug-in name is the RDN value from the plug-in configuration entry
1785 * DN). The list can include at most one asterisk to indicate the
1786 * position of any unspecified plug-in (and the relative order of
1787 * those unspecified plug-ins is undefined).
1788 *
1789 * @return Returns the value of the "plugin-order-search-result-entry" property.
1790 */
1791 String getPluginOrderSearchResultEntry();
1792
1793
1794
1795 /**
1796 * Sets the "plugin-order-search-result-entry" property.
1797 * <p>
1798 * Specifies the order in which search result entry plug-ins are to
1799 * be loaded and invoked.
1800 * <p>
1801 * The value is a comma-delimited list of plug-in names (where the
1802 * plug-in name is the RDN value from the plug-in configuration entry
1803 * DN). The list can include at most one asterisk to indicate the
1804 * position of any unspecified plug-in (and the relative order of
1805 * those unspecified plug-ins is undefined).
1806 *
1807 * @param value The value of the "plugin-order-search-result-entry" property.
1808 * @throws IllegalPropertyValueException
1809 * If the new value is invalid.
1810 */
1811 void setPluginOrderSearchResultEntry(String value) throws IllegalPropertyValueException;
1812
1813
1814
1815 /**
1816 * Gets the "plugin-order-search-result-reference" property.
1817 * <p>
1818 * Specifies the order in which search result reference plug-ins are
1819 * to be loaded and invoked.
1820 * <p>
1821 * The value is a comma-delimited list of plug-in names (where the
1822 * plug-in name is the RDN value from the plug-in configuration entry
1823 * DN). The list can include at most one asterisk to indicate the
1824 * position of any unspecified plug-in (and the relative order of
1825 * those unspecified plug-ins is undefined).
1826 *
1827 * @return Returns the value of the "plugin-order-search-result-reference" property.
1828 */
1829 String getPluginOrderSearchResultReference();
1830
1831
1832
1833 /**
1834 * Sets the "plugin-order-search-result-reference" property.
1835 * <p>
1836 * Specifies the order in which search result reference plug-ins are
1837 * to be loaded and invoked.
1838 * <p>
1839 * The value is a comma-delimited list of plug-in names (where the
1840 * plug-in name is the RDN value from the plug-in configuration entry
1841 * DN). The list can include at most one asterisk to indicate the
1842 * position of any unspecified plug-in (and the relative order of
1843 * those unspecified plug-ins is undefined).
1844 *
1845 * @param value The value of the "plugin-order-search-result-reference" property.
1846 * @throws IllegalPropertyValueException
1847 * If the new value is invalid.
1848 */
1849 void setPluginOrderSearchResultReference(String value) throws IllegalPropertyValueException;
1850
1851
1852
1853 /**
1854 * Gets the "plugin-order-shutdown" property.
1855 * <p>
1856 * Specifies the order in which shutdown plug-ins are to be loaded
1857 * and invoked.
1858 * <p>
1859 * The value is a comma-delimited list of plug-in names (where the
1860 * plug-in name is the RDN value from the plug-in configuration entry
1861 * DN). The list can include at most one asterisk to indicate the
1862 * position of any unspecified plug-in (and the relative order of
1863 * those unspecified plug-ins is undefined).
1864 *
1865 * @return Returns the value of the "plugin-order-shutdown" property.
1866 */
1867 String getPluginOrderShutdown();
1868
1869
1870
1871 /**
1872 * Sets the "plugin-order-shutdown" property.
1873 * <p>
1874 * Specifies the order in which shutdown plug-ins are to be loaded
1875 * and invoked.
1876 * <p>
1877 * The value is a comma-delimited list of plug-in names (where the
1878 * plug-in name is the RDN value from the plug-in configuration entry
1879 * DN). The list can include at most one asterisk to indicate the
1880 * position of any unspecified plug-in (and the relative order of
1881 * those unspecified plug-ins is undefined).
1882 *
1883 * @param value The value of the "plugin-order-shutdown" property.
1884 * @throws IllegalPropertyValueException
1885 * If the new value is invalid.
1886 */
1887 void setPluginOrderShutdown(String value) throws IllegalPropertyValueException;
1888
1889
1890
1891 /**
1892 * Gets the "plugin-order-startup" property.
1893 * <p>
1894 * Specifies the order in which startup plug-ins are to be loaded
1895 * and invoked.
1896 * <p>
1897 * The value is a comma-delimited list of plug-in names (where the
1898 * plug-in name is the RDN value from the plug-in configuration entry
1899 * DN). The list can include at most one asterisk to indicate the
1900 * position of any unspecified plug-in (and the relative order of
1901 * those unspecified plug-ins is undefined).
1902 *
1903 * @return Returns the value of the "plugin-order-startup" property.
1904 */
1905 String getPluginOrderStartup();
1906
1907
1908
1909 /**
1910 * Sets the "plugin-order-startup" property.
1911 * <p>
1912 * Specifies the order in which startup plug-ins are to be loaded
1913 * and invoked.
1914 * <p>
1915 * The value is a comma-delimited list of plug-in names (where the
1916 * plug-in name is the RDN value from the plug-in configuration entry
1917 * DN). The list can include at most one asterisk to indicate the
1918 * position of any unspecified plug-in (and the relative order of
1919 * those unspecified plug-ins is undefined).
1920 *
1921 * @param value The value of the "plugin-order-startup" property.
1922 * @throws IllegalPropertyValueException
1923 * If the new value is invalid.
1924 */
1925 void setPluginOrderStartup(String value) throws IllegalPropertyValueException;
1926
1927
1928
1929 /**
1930 * Gets the "plugin-order-subordinate-modify-dn" property.
1931 * <p>
1932 * Specifies the order in which subordinate modify DN plug-ins are
1933 * to be loaded and invoked.
1934 * <p>
1935 * The value is a comma-delimited list of plug-in names (where the
1936 * plug-in name is the RDN value from the plug-in configuration entry
1937 * DN). The list can include at most one asterisk to indicate the
1938 * position of any unspecified plug-in (and the relative order of
1939 * those unspecified plug-ins is undefined).
1940 *
1941 * @return Returns the value of the "plugin-order-subordinate-modify-dn" property.
1942 */
1943 String getPluginOrderSubordinateModifyDN();
1944
1945
1946
1947 /**
1948 * Sets the "plugin-order-subordinate-modify-dn" property.
1949 * <p>
1950 * Specifies the order in which subordinate modify DN plug-ins are
1951 * to be loaded and invoked.
1952 * <p>
1953 * The value is a comma-delimited list of plug-in names (where the
1954 * plug-in name is the RDN value from the plug-in configuration entry
1955 * DN). The list can include at most one asterisk to indicate the
1956 * position of any unspecified plug-in (and the relative order of
1957 * those unspecified plug-ins is undefined).
1958 *
1959 * @param value The value of the "plugin-order-subordinate-modify-dn" property.
1960 * @throws IllegalPropertyValueException
1961 * If the new value is invalid.
1962 */
1963 void setPluginOrderSubordinateModifyDN(String value) throws IllegalPropertyValueException;
1964
1965
1966
1967 /**
1968 * Lists the Plugins.
1969 *
1970 * @return Returns an array containing the names of the Plugins.
1971 * @throws ConcurrentModificationException
1972 * If this Plugin Root has been removed from the server by
1973 * another client.
1974 * @throws AuthorizationException
1975 * If the server refuses to list the Plugins because the
1976 * client does not have the correct privileges.
1977 * @throws CommunicationException
1978 * If the client cannot contact the server due to an
1979 * underlying communication problem.
1980 */
1981 String[] listPlugins() throws ConcurrentModificationException,
1982 AuthorizationException, CommunicationException;
1983
1984
1985
1986 /**
1987 * Gets the named Plugin.
1988 *
1989 * @param name
1990 * The name of the Plugin to retrieve.
1991 * @return Returns the named Plugin.
1992 * @throws DefinitionDecodingException
1993 * If the named Plugin was found but its type could not be
1994 * determined.
1995 * @throws ManagedObjectDecodingException
1996 * If the named Plugin was found but one or more of its
1997 * properties could not be decoded.
1998 * @throws ManagedObjectNotFoundException
1999 * If the named Plugin was not found on the server.
2000 * @throws ConcurrentModificationException
2001 * If this Plugin Root has been removed from the server by
2002 * another client.
2003 * @throws AuthorizationException
2004 * If the server refuses to retrieve the named Plugin
2005 * because the client does not have the correct privileges.
2006 * @throws CommunicationException
2007 * If the client cannot contact the server due to an
2008 * underlying communication problem.
2009 */
2010 PluginCfgClient getPlugin(String name)
2011 throws DefinitionDecodingException, ManagedObjectDecodingException,
2012 ManagedObjectNotFoundException, ConcurrentModificationException,
2013 AuthorizationException, CommunicationException;
2014
2015
2016
2017 /**
2018 * Creates a new Plugin. The new Plugin will initially not contain
2019 * any property values (including mandatory properties). Once the
2020 * Plugin has been configured it can be added to the server using the
2021 * {@link #commit()} method.
2022 *
2023 * @param <C>
2024 * The type of the Plugin being created.
2025 * @param d
2026 * The definition of the Plugin to be created.
2027 * @param name
2028 * The name of the new Plugin.
2029 * @param exceptions
2030 * An optional collection in which to place any {@link
2031 * DefaultBehaviorException}s that occurred whilst
2032 * attempting to determine the default values of the Plugin.
2033 * This argument can be <code>null<code>.
2034 * @return Returns a new Plugin configuration instance.
2035 * @throws IllegalManagedObjectNameException
2036 * If the name of the new Plugin is invalid.
2037 */
2038 <C extends PluginCfgClient> C createPlugin(
2039 ManagedObjectDefinition<C, ? extends PluginCfg> d, String name, Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException;
2040
2041
2042
2043 /**
2044 * Removes the named Plugin.
2045 *
2046 * @param name
2047 * The name of the Plugin to remove.
2048 * @throws ManagedObjectNotFoundException
2049 * If the Plugin does not exist.
2050 * @throws OperationRejectedException
2051 * If the server refuses to remove the Plugin due to some
2052 * server-side constraint which cannot be satisfied (for
2053 * example, if it is referenced by another managed object).
2054 * @throws ConcurrentModificationException
2055 * If this Plugin Root has been removed from the server by
2056 * another client.
2057 * @throws AuthorizationException
2058 * If the server refuses to remove the Plugin because the
2059 * client does not have the correct privileges.
2060 * @throws CommunicationException
2061 * If the client cannot contact the server due to an
2062 * underlying communication problem.
2063 */
2064 void removePlugin(String name)
2065 throws ManagedObjectNotFoundException, OperationRejectedException,
2066 ConcurrentModificationException, AuthorizationException,
2067 CommunicationException;
2068
2069 }