Package org.ldaptive.control.util

Class VirtualListViewParams

java.lang.Object
org.ldaptive.control.util.VirtualListViewParams
public class VirtualListViewParams extends Object
Contains data required by the virtual list view operation.

  • Field Details

    • logger

      protected final Logger logger
      Logger for this class.

    • beforeCount

      private final int beforeCount
      VLV before count.

    • afterCount

      private final int afterCount
      VLV after count.

    • targetOffset

      private final int targetOffset
      VLV target offset; mutually exclusive with the assertion value.

    • assertionValue

      private final String assertionValue
      VLV assertion value; mutually exclusive with the target offset.

    • cookieManager

      private final CookieManager cookieManager
      Cookie manager for VLV context ID.

  • Constructor Details

    • VirtualListViewParams

      public VirtualListViewParams(int offset, int before, int after)
      Creates a new virtual list view params.
      Parameters:
      offset - target offset
      before - before count
      after - after count

    • VirtualListViewParams

      public VirtualListViewParams(int offset, int before, int after, CookieManager manager)
      Creates a new virtual list view params.
      Parameters:
      offset - target offset
      before - before count
      after - after count
      manager - cookie manager

    • VirtualListViewParams

      public VirtualListViewParams(String assertion, int before, int after)
      Creates a new virtual list view params.
      Parameters:
      assertion - assertion value
      before - before count
      after - after count

    • VirtualListViewParams

      public VirtualListViewParams(String assertion, int before, int after, CookieManager manager)
      Creates a new virtual list view params.
      Parameters:
      assertion - assertion value
      before - before count
      after - after count
      manager - cookie manager

  • Method Details

    • getBeforeCount

      public int getBeforeCount()
      Returns the before count.
      Returns:
      before count

    • getAfterCount

      public int getAfterCount()
      Returns the after count.
      Returns:
      after count

    • getTargetOffset

      public int getTargetOffset()
      Returns the target offset.
      Returns:
      target offset

    • getAssertionValue

      public String getAssertionValue()
      Returns the assertion value.
      Returns:
      assertion value

    • getCookieManager

      public CookieManager getCookieManager()
      Returns the cookie manager.
      Returns:
      cookie manager

    • createRequestControl

      public VirtualListViewRequestControl createRequestControl(boolean critical)
      Creates a new virtual list view request control using the properties in this VLV params.
      Parameters:
      critical - whether the returned control is critical
      Returns:
      virtual list view request control

    • createRequestControl

      public VirtualListViewRequestControl createRequestControl(boolean critical, CookieManager manager)
      Creates a new virtual list view request control using the properties in this VLV params.
      Parameters:
      critical - whether the returned control is critical
      manager - cookie manager
      Returns:
      virtual list view request control

    • createRequestControl

      public VirtualListViewRequestControl createRequestControl(SearchResponse result, boolean critical)
      Creates a new virtual list view request control using the properties in this VLV params. The supplied response is inspected and if it contains a VLV response control, its contextID and/or content count will be passed into the created request control.
      Parameters:
      result - of a previous VLV operation
      critical - whether the returned control is critical
      Returns:
      virtual list view request control

    • toString

      public String toString()
      Overrides:
      toString in class Object