Package org.ldaptive.ad.control
Class DirSyncControl
java.lang.Object
org.ldaptive.control.AbstractControl
org.ldaptive.ad.control.DirSyncControl
- All Implemented Interfaces:
Control
,RequestControl
,ResponseControl
Request/response control for active directory synchronization. Control is defined as:
dirSyncValue ::= SEQUENCE { flags INTEGER, maxAttributeCount INTEGER, cookie OCTET STRING }
See http://msdn.microsoft.com/en-us/library/cc223347.aspx
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
Parse handler implementation for the cookie.static enum
Types of flags.private static class
Parse handler implementation for the flag.private static class
Parse handler implementation for the maxAttributeCount. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate byte[]
server generated cookie.private static final byte[]
Empty byte array used for null cookies.private long
flags.private static final int
hash value seed.private int
maximum attribute count.static final String
OID of this control.Fields inherited from class org.ldaptive.control.AbstractControl
logger
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.DirSyncControl
(boolean critical) Creates a new dir sync control.Creates a new dir sync control.DirSyncControl
(DirSyncControl.Flag[] f, boolean critical) Creates a new dir sync control.DirSyncControl
(DirSyncControl.Flag[] f, byte[] value, boolean critical) Creates a new dir sync control.DirSyncControl
(DirSyncControl.Flag[] f, byte[] value, int count, boolean critical) Creates a new dir sync control.DirSyncControl
(DirSyncControl.Flag[] f, int count) Creates a new dir sync control.DirSyncControl
(DirSyncControl.Flag[] f, int count, boolean critical) Creates a new dir sync control. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Initializes this response control with the supplied BER encoded data.byte[]
encode()
Provides the BER encoding of this control.boolean
byte[]
Returns the sync request cookie.long
getFlags()
Returns the flags value.int
Returns the maximum attribute count.int
hashCode()
Returns the hash code for this object.boolean
hasValue()
Returns whether the control has a value associated with it.void
setCookie
(byte[] value) Sets the sync request cookie.void
setFlags
(long l) Sets the flags.void
setMaxAttributeCount
(int count) Sets the maximum attribute count.toString()
Methods inherited from class org.ldaptive.control.AbstractControl
getCriticality, getOID
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.control.Control
getCriticality, getOID
-
Field Details
-
OID
OID of this control.- See Also:
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash value seed.- See Also:
-
EMPTY_COOKIE
private static final byte[] EMPTY_COOKIEEmpty byte array used for null cookies. -
flags
private long flagsflags. -
maxAttributeCount
private int maxAttributeCountmaximum attribute count. -
cookie
private byte[] cookieserver generated cookie.
-
-
Constructor Details
-
DirSyncControl
public DirSyncControl()Default constructor. -
DirSyncControl
public DirSyncControl(boolean critical) Creates a new dir sync control.- Parameters:
critical
- whether this control is critical
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flags
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flagscritical
- whether this control is critical
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flagscount
- maximum attribute count
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flagscount
- maximum attribute countcritical
- whether this control is critical
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flagsvalue
- dir sync cookiecritical
- whether this control is critical
-
DirSyncControl
Creates a new dir sync control.- Parameters:
f
- request flagsvalue
- dir sync cookiecount
- maximum attribute countcritical
- whether this control is critical
-
-
Method Details
-
hasValue
public boolean hasValue()Description copied from interface:RequestControl
Returns whether the control has a value associated with it.- Specified by:
hasValue
in interfaceRequestControl
- Returns:
- whether the control has a value
-
getFlags
public long getFlags()Returns the flags value.- Returns:
- flags value
-
setFlags
public void setFlags(long l) Sets the flags.- Parameters:
l
- flags value
-
getMaxAttributeCount
public int getMaxAttributeCount()Returns the maximum attribute count.- Returns:
- maximum attribute count
-
setMaxAttributeCount
public void setMaxAttributeCount(int count) Sets the maximum attribute count.- Parameters:
count
- maximum attribute count
-
getCookie
public byte[] getCookie()Returns the sync request cookie.- Returns:
- sync request cookie
-
setCookie
public void setCookie(byte[] value) Sets the sync request cookie.- Parameters:
value
- sync request cookie
-
equals
- Overrides:
equals
in classAbstractControl
-
hashCode
public int hashCode()Description copied from class:AbstractControl
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractControl
- Returns:
- hash code
-
toString
- Overrides:
toString
in classAbstractControl
-
encode
public byte[] encode()Description copied from interface:RequestControl
Provides the BER encoding of this control.- Specified by:
encode
in interfaceRequestControl
- Returns:
- BER encoded request control
-
decode
Description copied from interface:ResponseControl
Initializes this response control with the supplied BER encoded data.- Specified by:
decode
in interfaceResponseControl
- Parameters:
encoded
- BER encoded response control
-