Class LdapVirtualListResponseControl

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, javax.naming.ldap.Control

    public class LdapVirtualListResponseControl
    extends netscape.ldap.controls.LDAPVirtualListResponse
    implements javax.naming.ldap.Control
    Represents control data for returning paged results from a search.
          VirtualListViewResponse ::= SEQUENCE {
                   firstPosition    INTEGER,
                   contentCount     INTEGER,
                   virtualListViewResult ENUMERATED {
                     success                  (0),
                     unwillingToPerform       (53),
                     insufficientAccessRights (50),
                     operationsError          (1),
                     busy                     (51),
                     timeLimitExceeded        (3),
                     adminLimitExceeded       (11),
                     sortControlMissing       (60),
                     indexRangeError          (?),
                   }
         }
    
    See Also:
    Serialized Form
    • Field Summary

      • Fields inherited from class netscape.ldap.controls.LDAPVirtualListResponse

        VIRTUALLISTRESPONSE
      • Fields inherited from class netscape.ldap.LDAPControl

        m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING
      • Fields inherited from interface javax.naming.ldap.Control

        CRITICAL, NONCRITICAL
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getContentCount()
      Gets the size of the virtual result set.
      byte[] getEncodedValue()
      Retrieves the ASN.1 BER encoded value of the LDAP control.
      int getFirstPosition()
      Gets the index of the first entry returned.
      int getResultCode()
      Gets the result code.
      • Methods inherited from class netscape.ldap.controls.LDAPVirtualListResponse

        getContext, parseResponse, toString
      • Methods inherited from class netscape.ldap.LDAPControl

        clone, createControl, flattenBER, getID, getValue, isCritical, lookupControlClass, newInstance, register
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface javax.naming.ldap.Control

        getID, isCritical
    • Method Detail

      • getContentCount

        public int getContentCount()
        Gets the size of the virtual result set.
        Overrides:
        getContentCount in class netscape.ldap.controls.LDAPVirtualListResponse
        Returns:
        The size of the virtual result set, or -1 if not known.
      • getFirstPosition

        public int getFirstPosition()
        Gets the index of the first entry returned.
        Overrides:
        getFirstPosition in class netscape.ldap.controls.LDAPVirtualListResponse
        Returns:
        The index of the first entry returned.
      • getResultCode

        public int getResultCode()
        Gets the result code.
        Overrides:
        getResultCode in class netscape.ldap.controls.LDAPVirtualListResponse
        Returns:
        The result code.
      • getEncodedValue

        public byte[] getEncodedValue()
        Retrieves the ASN.1 BER encoded value of the LDAP control. Null is returned if the value is absent.
        Specified by:
        getEncodedValue in interface javax.naming.ldap.Control
        Returns:
        A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.