|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnetscape.ldap.LDAPControl
netscape.ldap.controls.LDAPVirtualListResponse
public class LDAPVirtualListResponse
Represents control data for returning paged results from a search.
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 }
Field Summary | |
---|---|
static java.lang.String |
VIRTUALLISTRESPONSE
|
Fields inherited from class netscape.ldap.LDAPControl |
---|
m_critical, m_value, MANAGEDSAIT, PWEXPIRED, PWEXPIRING |
Constructor Summary | |
---|---|
LDAPVirtualListResponse()
Blank constructor for internal use in LDAPVirtualListResponse . |
|
LDAPVirtualListResponse(byte[] value)
Constructs a new LDAPVirtualListResponse object. |
|
LDAPVirtualListResponse(java.lang.String oid,
boolean critical,
byte[] value)
Contructs an LDAPVirtualListResponse object. |
Method Summary | |
---|---|
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 |
---|
public static final java.lang.String VIRTUALLISTRESPONSE
Constructor Detail |
---|
LDAPVirtualListResponse()
LDAPVirtualListResponse
.
LDAPControl
public LDAPVirtualListResponse(java.lang.String oid, boolean critical, byte[] value) throws LDAPException
LDAPVirtualListResponse
object.
oid
- this parameter must be equal to
LDAPVirtualListResponse.VIRTUALLISTRESPONSE
or an
LDAPException
is throwncritical
- true
if this control is criticalvalue
- the value associated with this control
LDAPException
- If oid is not
LDAPVirtualListResponse.VIRTUALLISTRESPONSE
.LDAPControl.register(java.lang.String, java.lang.Class)
public LDAPVirtualListResponse(byte[] value)
LDAPVirtualListResponse
object.
value
- a BER encoded byte arrayLDAPControl
Method Detail |
---|
public int getContentCount()
public int getFirstPosition()
public int getResultCode()
public java.lang.String getContext()
public static LDAPVirtualListResponse parseResponse(LDAPControl[] controls)
controls
- an array of controls that may include a VLV
results control
public java.lang.String toString()
LDAPControl
toString
in class LDAPControl
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |