Class LdapVirtualListResponseControl

java.lang.Object
netscape.ldap.LDAPControl
netscape.ldap.controls.LDAPVirtualListResponse
com.netscape.jndi.ldap.controls.LdapVirtualListResponseControl
All Implemented Interfaces:
Serializable, Cloneable, Control
public class LdapVirtualListResponseControl extends LDAPVirtualListResponse implements 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:

  • Constructor Details

    • LdapVirtualListResponseControl

      LdapVirtualListResponseControl(boolean critical, byte[] value) throws Exception
      Constructs a new LDAPVirtualListResponse object.
      Parameters:
      value - A BER encoded byte array. This constructor is used by the NetscapeControlFactory
      Throws:
      Exception

  • Method Details

    • getContentCount

      public int getContentCount()
      Gets the size of the virtual result set.
      Overrides:
      getContentCount in class 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 LDAPVirtualListResponse
      Returns:
      The index of the first entry returned.

    • getResultCode

      public int getResultCode()
      Gets the result code.
      Overrides:
      getResultCode in class 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 Control
      Returns:
      A possibly null byte array representing the ASN.1 BER encoded value of the LDAP control.