|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.jndi.ldap.BasicControl
com.sun.jndi.ldap.ctl.DirSyncControl
public final class DirSyncControl
This class implements the LDAPv3 Request Control for directory synchronization as defined in draft-armijo-ldap-dirsync-01.txt The control's value has the following ASN.1 definition:
realReplControlValue ::= SEQUENCE { parentsFirst INTEGER, maxReturnlength INTEGER, cookie OCTET STRING }
DirSyncResponseControl
,
Serialized FormField Summary | |
---|---|
private byte[] |
cookie
A server-generated cookie. |
private int |
maxReturnLength
The maximum length (in bytes) to be returned in a control response. |
static java.lang.String |
OID
The dir-sync control's assigned object identifier is 1.2.840.113556.1.4.841. |
private int |
parentsFirst
Parent entries are returned before their children when value is set to 1. |
private static long |
serialVersionUID
|
Fields inherited from class com.sun.jndi.ldap.BasicControl |
---|
criticality, id, value |
Fields inherited from interface javax.naming.ldap.Control |
---|
CRITICAL, NONCRITICAL |
Constructor Summary | |
---|---|
DirSyncControl()
Constructs a dir-sync control. |
|
DirSyncControl(boolean criticality)
Constructs a dir-sync control. |
|
DirSyncControl(int parentsFirst,
int maxReturnLength,
byte[] cookie,
boolean criticality)
Constructs a dir-sync control. |
Method Summary | |
---|---|
private byte[] |
setEncodedValue()
|
Methods inherited from class com.sun.jndi.ldap.BasicControl |
---|
getEncodedValue, getID, isCritical |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String OID
private int parentsFirst
private int maxReturnLength
private byte[] cookie
private static final long serialVersionUID
Constructor Detail |
---|
public DirSyncControl() throws java.io.IOException
java.io.IOException
- If a BER encoding error occurs.public DirSyncControl(boolean criticality) throws java.io.IOException
criticality
- The control's criticality setting.
java.io.IOException
- If a BER encoding error occurs.public DirSyncControl(int parentsFirst, int maxReturnLength, byte[] cookie, boolean criticality) throws java.io.IOException
parentsFirst
- Parent entries are returned before their
children when value is set to 1.maxReturnLength
- The maximum length (in bytes) to be returned
in a control response. Must be greater than
zero for any data to be returned.cookie
- A server-generated cookie.criticality
- The control's criticality setting.
java.io.IOException
- If a BER encoding error occurs.Method Detail |
---|
private byte[] setEncodedValue() throws java.io.IOException
java.io.IOException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |