public interface ModifyRequest extends Request, ChangeRecord
The following example adds a member to a static group entry.
Connection connection = ...; String groupDN = ...; String memberDN = ...; ModifyRequest addMember = Requests.newModifyRequest(groupDN) .addModification(ModificationType.ADD, "member", memberDN); connection.modify(addMember);
Modifier and Type | Method and Description |
---|---|
<R,P> R |
accept(ChangeRecordVisitor<R,P> v,
P p)
Applies a
ChangeRecordVisitor to this ChangeRecord . |
ModifyRequest |
addControl(Control control)
Adds the provided control to this request.
|
ModifyRequest |
addModification(Modification modification)
Appends the provided modification to the list of modifications included
with this modify request.
|
ModifyRequest |
addModification(ModificationType type,
String attributeDescription,
Object... values)
Appends the provided modification to the list of modifications included
with this modify request.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
request. |
List<Modification> |
getModifications()
Returns a
List containing the modifications included with this
modify request. |
DN |
getName()
Returns the distinguished name of the entry to be modified.
|
ModifyRequest |
setName(DN dn)
Sets the distinguished name of the entry to be modified.
|
ModifyRequest |
setName(String dn)
Sets the distinguished name of the entry to be modified.
|
containsControl
<R,P> R accept(ChangeRecordVisitor<R,P> v, P p)
ChangeRecord
ChangeRecordVisitor
to this ChangeRecord
.accept
in interface ChangeRecord
R
- The return type of the visitor's methods.P
- The type of the additional parameters to the visitor's
methods.v
- The change record visitor.p
- Optional additional visitor parameter.ModifyRequest addControl(Control control)
Request
addControl
in interface Request
control
- The control to be added to this request.ModifyRequest addModification(Modification modification)
modification
- The modification to be performed.UnsupportedOperationException
- If this modify request does not permit modifications to be
added.NullPointerException
- If modification
was null
.ModifyRequest addModification(ModificationType type, String attributeDescription, Object... values)
If the attribute value is not an instance of ByteString
then it
will be converted using the ByteString.valueOfObject(Object)
method.
type
- The type of modification to be performed.attributeDescription
- The name of the attribute to be modified.values
- The attribute values to be modified.LocalizedIllegalArgumentException
- If attributeDescription
could not be decoded using
the default schema.UnsupportedOperationException
- If this modify request does not permit modifications to be
added.NullPointerException
- If type
, attributeDescription
, or
value
was null
.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this request.DecodeException
- If the control could not be decoded because it was malformed
in some way (e.g. the control value was missing, or its
content could not be decoded).List<Control> getControls()
Request
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.getControls
in interface Request
List
containing the controls.List<Modification> getModifications()
List
containing the modifications included with this
modify request. The returned List
may be modified if permitted by
this modify request.List
containing the modifications.DN getName()
getName
in interface ChangeRecord
ModifyRequest setName(DN dn)
dn
- The the distinguished name of the entry to be modified.UnsupportedOperationException
- If this modify request does not permit the distinguished name
to be set.NullPointerException
- If dn
was null
.ModifyRequest setName(String dn)
dn
- The the distinguished name of the entry to be modified.LocalizedIllegalArgumentException
- If dn
could not be decoded using the default schema.UnsupportedOperationException
- If this modify request does not permit the distinguished name
to be set.NullPointerException
- If dn
was null
.Copyright 2010-2017 ForgeRock AS.