Package netscape.ldap.controls

Class LDAPVirtualListResponse

java.lang.Object

netscape.ldap.LDAPControl

netscape.ldap.controls.LDAPVirtualListResponse

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class LDAPVirtualListResponse
extends LDAPControl

Represents control data for returning paged results from a search.

Version:

1.0

   VirtualListViewResponse ::= SEQUENCE {
       targetPosition   INTEGER (0 .. maxInt),
       contentCount     INTEGER (0 .. maxInt),
       virtualListViewResult ENUMERATED {
           success                  (0),
           operatonsError           (1),
           timeLimitExceeded        (3),
           adminLimitExceeded       (11),
           insufficientAccessRights (50),
           busy                     (51),
           unwillingToPerform       (53),
           sortControlMissing       (60),
           offsetRangeError         (61),
           other                    (80)
       },
       contextID     OCTET STRING OPTIONAL
  }

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	VIRTUALLISTRESPONSE

Fields inherited from class netscape.ldap.LDAPControl

m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING

Constructor Summary

Constructors

Constructor	Description
LDAPVirtualListResponse(byte[] value)	Constructs a new LDAPVirtualListResponse object.
LDAPVirtualListResponse(java.lang.String oid, boolean critical, byte[] value)	Contructs an LDAPVirtualListResponse object.

Method Summary

Modifier and Type	Method	Description
int	getContentCount()	Gets the size of the virtual result set.
java.lang.String	getContext()	Gets the context cookie, if any.
int	getFirstPosition()	Gets the index of the first entry returned.
int	getResultCode()	Gets the result code.
static LDAPVirtualListResponse	parseResponse(LDAPControl[] controls)	Deprecated. LDAPVirtualListResponse controls are now automatically instantiated.
java.lang.String	toString()	Return a string representation of the control for debugging

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

Field Detail

VIRTUALLISTRESPONSE

public static final java.lang.String VIRTUALLISTRESPONSE

See Also:

Constant Field Values

Constructor Detail

LDAPVirtualListResponse

public LDAPVirtualListResponse(java.lang.String oid,
                               boolean critical,
                               byte[] value)
                        throws LDAPException

Contructs an LDAPVirtualListResponse object.

Parameters:

oid - this parameter must be equal to LDAPVirtualListResponse.VIRTUALLISTRESPONSE or an LDAPExceptionis thrown

critical - true if this control is critical

value - the value associated with this control

Throws:

LDAPException - If oid is not LDAPVirtualListResponse.VIRTUALLISTRESPONSE.

See Also:

LDAPControl.register(java.lang.String, java.lang.Class<?>)

LDAPVirtualListResponse

public LDAPVirtualListResponse(byte[] value)

Constructs a new LDAPVirtualListResponse object.

Parameters:

value - a BER encoded byte array

See Also:

LDAPControl

Method Detail

getContentCount

public int getContentCount()

Gets the size of the virtual result set.

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.

Returns:

the index of the first entry returned.

getResultCode

public int getResultCode()

Gets the result code.

Returns:

the result code.

getContext

public java.lang.String getContext()

Gets the context cookie, if any.

Returns:

the result context cookie.

parseResponse

@Deprecated
public static LDAPVirtualListResponse parseResponse(LDAPControl[] controls)

Deprecated.

LDAPVirtualListResponse controls are now automatically instantiated.

Returns a control returned on a VLV search.

Parameters:

controls - an array of controls that may include a VLV results control

Returns:

the control, if any; otherwise null.

toString

public java.lang.String toString()

Description copied from class: LDAPControl

Return a string representation of the control for debugging

Overrides:

toString in class LDAPControl

Returns:

a string representation of the control.