1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.directory.api.ldap.model.message.controls;
20
21
22 import org.apache.directory.api.ldap.model.message.Control;
23
24
25 /**
26 * Control which allows for the management of referrals and other DSA specific
27 * entities without processing them: meaning the referrals are treated as
28 * regular entries using this control. More information is available in
29 * <a href="https://www.ietf.org/rfc/rfc3296.txt">RFC 3296</a>. Below we have
30 * included section 3 of the RFC describing this control:
31 *
32 * <pre>
33 * 3. The ManageDsaIT Control
34 *
35 * The client may provide the ManageDsaIT control with an operation to
36 * indicate that the operation is intended to manage objects within the
37 * DSA (server) Information Tree. The control causes Directory-specific
38 * entries (DSEs), regardless of type, to be treated as normal entries
39 * allowing clients to interrogate and update these entries using LDAP
40 * operations.
41 *
42 * A client MAY specify the following control when issuing an add,
43 * compare, delete, modify, modifyDN, search request or an extended
44 * operation for which the control is defined.
45 *
46 * The control type is 2.16.840.1.113730.3.4.2. The control criticality
47 * may be TRUE or, if FALSE, absent. The control value is absent.
48 *
49 * When the control is present in the request, the server SHALL NOT
50 * generate a referral or continuation reference based upon information
51 * held in referral objects and instead SHALL treat the referral object
52 * as a normal entry. The server, however, is still free to return
53 * referrals for other reasons. When not present, referral objects
54 * SHALL be handled as described above.
55 *
56 * The control MAY cause other objects to be treated as normal entries
57 * as defined by subsequent documents.
58 * </pre>
59 *
60 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
61 */
62 public interface ManageDsaIT extends Control
63 {
64 /** This control OID */
65 String OID = "2.16.840.1.113730.3.4.2";
66 }