Package org.forgerock.opendj.ldap.controls

Class ManageDsaItRequestControl

  • All Implemented Interfaces:
    Control
    public final class ManageDsaItRequestControl
extends Object
implements Control
    The ManageDsaIT request control as defined in RFC 3296. This control allows manipulation of referral and other special objects as normal objects.

    When this control is present in the request, the server will not generate a referral or continuation reference based upon information held in referral objects and instead will treat the referral object as a normal entry. The server, however, is still free to return referrals for other reasons. 

     // "dc=ref,dc=com" holds a referral to something else.

 // Referral without the ManageDsaIT control:
 SearchRequest request = Requests.newSearchRequest(
          "dc=ref,dc=com",
          SearchScope.SUBORDINATES,
          "(objectclass=*)",
          "");

 ConnectionEntryReader reader = connection.search(request);
 while (reader.hasNext()) {
     if (reader.isReference()) {
         SearchResultReference ref = reader.readReference();
         // References: ref.getURIs()
     }
 }

 // Referral with the ManageDsaIT control:
 request.addControl(ManageDsaITRequestControl.newControl(true));
 SearchResultEntry entry = connection.searchSingleEntry(request);
 // ...
    See Also:
    RFC 3296 - Named Subordinate References in Lightweight Directory Access Protocol (LDAP) Directories

    • Method Detail

      • newControl

        public static ManageDsaItRequestControl newControl​(boolean isCritical)
        Creates a new ManageDsaIT request control having the provided criticality.
        Parameters:
        isCritical - true if it is unacceptable to perform the operation without applying the semantics of this control, or false if it can be ignored.
        Returns:
        The new control.

      • getOid

        public String getOid()
        Description copied from interface: Control
        Returns the numeric OID associated with this control.
        Specified by:
        getOid in interface Control
        Returns:
        The numeric OID associated with this control.

      • getValue

        public ByteString getValue()
        Description copied from interface: Control
        Returns the value, if any, associated with this control. Its format is defined by the specification of this control.
        Specified by:
        getValue in interface Control
        Returns:
        The value associated with this control, or null if there is no value.

      • hasValue

        public boolean hasValue()
        Description copied from interface: Control
        Returns true if this control has a value. In some circumstances it may be useful to determine if a control has a value, without actually calculating the value and incurring any performance costs.
        Specified by:
        hasValue in interface Control
        Returns:
        true if this control has a value, or false if there is no value.

      • isCritical

        public boolean isCritical()
        Description copied from interface: Control
        Returns true if it is unacceptable to perform the operation without applying the semantics of this control.

        The criticality field only has meaning in controls attached to request messages (except UnbindRequest). For controls attached to response messages and the UnbindRequest, the criticality field SHOULD be false, and MUST be ignored by the receiving protocol peer. A value of true indicates that it is unacceptable to perform the operation without applying the semantics of the control.

        Specified by:
        isCritical in interface Control
        Returns:
        true if this control must be processed by the Directory Server, or false if it can be ignored.