|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.ldap.LDAPControl
com.novell.ldap.controls.LDAPVirtualListResponse
public class LDAPVirtualListResponse
LDAPVirtualListResponse is a Server Control returned by the server in
response to a virtual list search request.
In response to a VLV Search request the server returns an error code
and if the search was successful returns the following information:
Sample Code: VLVControl.java
Field Summary | |
---|---|
private int |
m_ContentCount
|
private java.lang.String |
m_context
|
private int |
m_firstPosition
|
private int |
m_resultCode
|
Constructor Summary | |
---|---|
LDAPVirtualListResponse(java.lang.String oid,
boolean critical,
byte[] values)
This constructor is usually called by the SDK to instantiate an a LDAPControl corresponding to the Server response to a LDAP VLV Control request. |
Method Summary | |
---|---|
int |
getContentCount()
Returns the size of the virtual search results list. |
java.lang.String |
getContext()
Returns the cookie used by some servers to optimize the processing of virtual list requests. |
int |
getFirstPosition()
Returns the index of the first entry in the returned list. |
int |
getResultCode()
Returns the result code for the virtual list search request. |
Methods inherited from class com.novell.ldap.LDAPControl |
---|
clone, getID, getValue, isCritical, readDSML, readExternal, register, setValue, toString, writeDSML, writeExternal |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private int m_firstPosition
private int m_ContentCount
private int m_resultCode
private java.lang.String m_context
Constructor Detail |
---|
public LDAPVirtualListResponse(java.lang.String oid, boolean critical, byte[] values) throws java.io.IOException
RFC 2891 defines this response control as follows:
The controlValue is an OCTET STRING, whose value is the BER
encoding of a value of the following ASN.1:
VirtualListViewResponse ::= SEQUENCE {
targetPosition INTEGER (0 .. maxInt),
contentCount INTEGER (0 .. maxInt),
virtualListViewResult ENUMERATED {
success (0),
operationsError (1),
unwillingToPerform (53),
insufficientAccessRights (50),
busy (51),
timeLimitExceeded (3),
adminLimitExceeded (11),
sortControlMissing (60),
offsetRangeError (61),
other (80) },
contextID OCTET STRING OPTIONAL }
oid
- The OID of the control, as a dotted string.
critical
- True if the LDAP operation should be discarded if
the control is not supported. False if
the operation can be processed without the control.
values
- The control-specific data.
java.io.IOException
Method Detail |
---|
public int getContentCount()
public int getFirstPosition()
public int getResultCode()
public java.lang.String getContext()
|
All LDAP Classes Internal LDAP Classes |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |