Class VirtualAttributesOnlyRequestControl

  • All Implemented Interfaces:
    java.io.Serializable

    @NotMutable
    @ThreadSafety(level=COMPLETELY_THREADSAFE)
    public final class VirtualAttributesOnlyRequestControl
    extends Control
    This class provides an implementation of the virtual attributes only request control, which may be included in a search request to indicate that only virtual attributes should be included in matching entries.
    NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

    This control is not based on any public standard, but was first introduced in the Netscape/iPlanet Directory Server. It is also supported in the Sun Java System Directory Server, OpenDS, and the Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 Directory Server. It does not have a value.

    Example

    The following example demonstrates the use of the virtual attributes only request control:
     SearchRequest searchRequest = new SearchRequest("dc=example,dc=com",
          SearchScope.SUB, Filter.createEqualityFilter("uid", "john.doe"));
    
     searchRequest.addControl(new VirtualAttributesOnlyRequestControl());
     SearchResult searchResult = connection.search(searchRequest);
     
    See Also:
    Serialized Form
    • Constructor Detail

      • VirtualAttributesOnlyRequestControl

        public VirtualAttributesOnlyRequestControl​(boolean isCritical)
        Creates a new virtual attributes only request control with the specified criticality.
        Parameters:
        isCritical - Indicates whether this control should be marked critical.
      • VirtualAttributesOnlyRequestControl

        public VirtualAttributesOnlyRequestControl​(Control control)
                                            throws LDAPException
        Creates a new virtual attributes only request control which is decoded from the provided generic control.
        Parameters:
        control - The generic control to be decoded as a virtual attributes only request control.
        Throws:
        LDAPException - If the provided control cannot be decoded as a virtual attributes only request control.
    • Method Detail

      • getControlName

        public java.lang.String getControlName()
        Retrieves the user-friendly name for this control, if available. If no user-friendly name has been defined, then the OID will be returned.
        Overrides:
        getControlName in class Control
        Returns:
        The user-friendly name for this control, or the OID if no user-friendly name is available.
      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this LDAP control to the provided buffer.
        Overrides:
        toString in class Control
        Parameters:
        buffer - The buffer to which to append the string representation of this buffer.