Package com.netscape.jndi.ldap.controls

Class LdapVirtualListControl

java.lang.Object
netscape.ldap.LDAPControl
netscape.ldap.controls.LDAPVirtualListControl
com.netscape.jndi.ldap.controls.LdapVirtualListControl
All Implemented Interfaces:
Serializable, Cloneable, Control
public class LdapVirtualListControl extends LDAPVirtualListControl implements Control
Represents control data for returning paged results from a search. 
      VirtualListViewRequest ::= SEQUENCE {
                      beforeCount    INTEGER,
                      afterCount     INTEGER,
                      CHOICE {
                      byIndex [0] SEQUENCE {
                          index           INTEGER,
                          contentCount    INTEGER }
                      byFilter [1] jumpTo    Substring }
See Also:

  • Constructor Details

    • LdapVirtualListControl

      public LdapVirtualListControl(String jumpTo, int beforeCount, int afterCount)
      Constructs a new LDAPVirtualListControl object. Use this constructor on an initial search operation, specifying the first entry to be matched, or the initial part of it.
      Parameters:
      jumpTo - An LDAP search expression defining the result set.
      beforeCount - The number of results before the top/center to return per page.
      afterCount - The number of results after the top/center to return per page.

    • LdapVirtualListControl

      public LdapVirtualListControl(int startIndex, int beforeCount, int afterCount, int contentCount)
      Constructs a new LDAPVirtualListControl object. Use this constructor on a subsquent search operation, after we know the size of the virtual list, to fetch a subset.
      Parameters:
      startIndex - The index into the virtual list of an entry to return.
      beforeCount - The number of results before the top/center to return per page.
      afterCount - The number of results after the top/center to return per page.

  • Method Details

    • setRange

      public void setRange(int startIndex, int beforeCount, int afterCount)
      Sets the starting index, and the number of entries before and after to return. Apply this method to a control returned from a previous search, to specify what result range to return on the next search.
      Overrides:
      setRange in class LDAPVirtualListControl
      Parameters:
      startIndex - The index into the virtual list of an entry to return.
      beforeCount - The number of results before startIndex to return per page.
      afterCount - The number of results after startIndex to return per page.
      See Also:

    • setRange

      public void setRange(String jumpTo, int beforeCount, int afterCount)
      Sets the search expression, and the number of entries before and after to return.
      Overrides:
      setRange in class LDAPVirtualListControl
      Parameters:
      jumpTo - An LDAP search expression defining the result set. return.
      beforeCount - The number of results before startIndex to return per page.
      afterCount - The number of results after startIndex to return per page.
      See Also:

    • getIndex

      public int getIndex()
      Gets the size of the virtual result set.
      Overrides:
      getIndex in class LDAPVirtualListControl
      Returns:
      The size of the virtual result set, or -1 if not known.

    • getListSize

      public int getListSize()
      Gets the size of the virtual result set.
      Overrides:
      getListSize in class LDAPVirtualListControl
      Returns:
      The size of the virtual result set, or -1 if not known.

    • setListSize

      public void setListSize(int listSize)
      Sets the size of the virtual result set.
      Overrides:
      setListSize in class LDAPVirtualListControl
      Parameters:
      listSize - The virtual result set size.

    • getBeforeCount

      public int getBeforeCount()
      Gets the number of results before the top/center to return per page.
      Overrides:
      getBeforeCount in class LDAPVirtualListControl
      Returns:
      The number of results before the top/center to return per page.

    • getAfterCount

      public int getAfterCount()
      Gets the number of results after the top/center to return per page.
      Overrides:
      getAfterCount in class LDAPVirtualListControl
      Returns:
      The number of results after the top/center to return per page.

    • 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.