@NotExtensible @ThreadSafety(level=NOT_THREADSAFE) public abstract class UpdatableLDAPRequest extends LDAPRequest
Modifier | Constructor and Description |
---|---|
protected |
UpdatableLDAPRequest(Control[] controls)
Creates a new LDAP request with the provided set of controls.
|
Modifier and Type | Method and Description |
---|---|
void |
addControl(Control control)
Adds the provided control to the set of controls for this request.
|
void |
addControls(Control... controls)
Adds the provided controls to the set of controls for this request.
|
void |
clearControls()
Removes all controls from this request.
|
boolean |
removeControl(Control control)
Removes the provided control from the set of controls for this request.
|
Control |
removeControl(java.lang.String oid)
Removes the control with the specified OID from the set of controls for
this request.
|
Control |
replaceControl(Control control)
Replaces the control with the same OID as the provided control with the
provided control.
|
Control |
replaceControl(java.lang.String oid,
Control control)
Replaces the control with the specified OID with the provided control.
|
void |
setControls(Control... controls)
Specifies the set of controls for this request.
|
void |
setControls(java.util.List<Control> controls)
Specifies the set of controls for this request.
|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getLastMessageID, getOperationType, getResponseTimeoutMillis, hasControl, hasControl, process, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
duplicate, duplicate
protected UpdatableLDAPRequest(Control[] controls)
controls
- The set of controls to include in this LDAP request.public final void setControls(Control... controls)
controls
- The set of controls for this request.public final void setControls(java.util.List<Control> controls)
controls
- The set of controls for this request.public final void clearControls()
public final void addControl(Control control)
control
- The control to add to the set of controls for this
request. It must not be null
.public final void addControls(Control... controls)
controls
- The controls to add to the set of controls for this
request.public final Control removeControl(java.lang.String oid)
oid
- The OID of the control to remove. It must not be
null
.null
if this request does
not have any control with the specified OID.public final boolean removeControl(Control control)
control
- The control to remove from the set of controls for this
request. It must not be null
.true
if the control was found and removed, or
false
if not.public final Control replaceControl(Control control)
control
- The control to use in place of the existing control with
the same OID. It must not be null
.null
if there was no
control with the same OID as the provided control.public final Control replaceControl(java.lang.String oid, Control control)
oid
- The OID of the control to replace with the provided
control. It must not be null
.control
- The control to use in place of the control with the
specified OID. It may be null
if the control
should be removed. It may have a different OID than the
OID of the control being replaced.null
if there was no
control with the specified OID.