|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.UpdatableLDAPRequest
com.unboundid.ldap.sdk.ModifyRequest
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ModifyRequest
This class implements the processing necessary to perform an LDAPv3 modify
operation, which can be used to update an entry in the directory server. A
modify request contains the DN of the entry to modify, as well as one or more
changes to apply to that entry. See the Modification
class for more
information about the types of modifications that may be processed.
A modify request can be created with a DN and set of modifications, but it
can also be as a list of the lines that comprise the LDIF representation of
the modification as described in
RFC 2849. For example, the
following code demonstrates creating a modify request from the LDIF
representation of the modification:
ModifyRequest modifyRequest = new ModifyRequest( "dn: dc=example,dc=com", "changetype: modify", "replace: description", "description: This is the new description.");
ModifyRequest
objects are mutable and therefore can be altered and
re-used for multiple requests. Note, however, that ModifyRequest
objects are not threadsafe and therefore a single ModifyRequest
object instance should not be used to process multiple requests at the same
time.
Constructor Summary | |
---|---|
ModifyRequest(DN dn,
java.util.List<Modification> mods)
Creates a new modify request with the provided information. |
|
ModifyRequest(DN dn,
java.util.List<Modification> mods,
Control[] controls)
Creates a new modify request with the provided information. |
|
ModifyRequest(DN dn,
Modification... mods)
Creates a new modify request with the provided information. |
|
ModifyRequest(DN dn,
Modification mod)
Creates a new modify request with the provided information. |
|
ModifyRequest(DN dn,
Modification[] mods,
Control[] controls)
Creates a new modify request with the provided information. |
|
ModifyRequest(DN dn,
Modification mod,
Control[] controls)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String... ldifModificationLines)
Creates a new modify request from the provided LDIF representation of the changes. |
|
ModifyRequest(java.lang.String dn,
java.util.List<Modification> mods)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String dn,
java.util.List<Modification> mods,
Control[] controls)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String dn,
Modification... mods)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String dn,
Modification mod)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String dn,
Modification[] mods,
Control[] controls)
Creates a new modify request with the provided information. |
|
ModifyRequest(java.lang.String dn,
Modification mod,
Control[] controls)
Creates a new modify request with the provided information. |
Method Summary | |
---|---|
void |
addModification(Modification mod)
Adds the provided modification to the set of modifications for this modify request. |
ModifyRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ModifyRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ASN1Element |
encodeProtocolOp()
Encodes the modify request protocol op to an ASN.1 element. |
java.lang.String |
getDN()
Retrieves the DN of the entry to modify. |
int |
getLastMessageID()
Retrieves the message ID for the last LDAP message sent using this request. |
java.util.List<Modification> |
getModifications()
Retrieves the set of modifications for this modify request. |
OperationType |
getOperationType()
Retrieves the type of operation that is represented by this request. |
byte |
getProtocolOpType()
Retrieves the BER type for this protocol op. |
protected LDAPResult |
process(LDAPConnection connection,
int depth)
Sends this modify request to the directory server over the provided connection and returns the associated response. |
boolean |
removeModification(Modification mod)
Removes the provided modification from the set of modifications for this modify request. |
void |
responseReceived(LDAPResponse response)
Indicates that the provided LDAP response has been received by from the server. |
void |
setDN(DN dn)
Specifies the DN of the entry to modify. |
void |
setDN(java.lang.String dn)
Specifies the DN of the entry to modify. |
void |
setModifications(java.util.List<Modification> mods)
Replaces the existing set of modifications for this modify request with the provided modifications. |
void |
setModifications(Modification mod)
Replaces the existing set of modifications for this modify request with the provided modification. |
void |
setModifications(Modification[] mods)
Replaces the existing set of modifications for this modify request with the provided modifications. |
java.lang.String[] |
toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding modify change record. |
LDIFModifyChangeRecord |
toLDIFChangeRecord()
Retrieves an LDIF modify change record with the contents of this modify request. |
java.lang.String |
toLDIFString()
Retrieves an LDIF string representation of this modify request. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
void |
writeTo(ASN1Buffer writer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. |
Methods inherited from class com.unboundid.ldap.sdk.UpdatableLDAPRequest |
---|
addControl, addControls, clearControls, removeControl, removeControl, replaceControl, replaceControl, setControls, setControls |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest |
---|
followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toString |
Constructor Detail |
---|
public ModifyRequest(java.lang.String dn, Modification mod)
dn
- The DN of the entry to modify. It must not be null
.mod
- The modification to apply to the entry. It must not be
null
.public ModifyRequest(java.lang.String dn, Modification... mods)
dn
- The DN of the entry to modify. It must not be null
.mods
- The set of modifications to apply to the entry. It must not
be null
or empty.public ModifyRequest(java.lang.String dn, java.util.List<Modification> mods)
dn
- The DN of the entry to modify. It must not be null
.mods
- The set of modifications to apply to the entry. It must not
be null
or empty.public ModifyRequest(DN dn, Modification mod)
dn
- The DN of the entry to modify. It must not be null
.mod
- The modification to apply to the entry. It must not be
null
.public ModifyRequest(DN dn, Modification... mods)
dn
- The DN of the entry to modify. It must not be null
.mods
- The set of modifications to apply to the entry. It must not
be null
or empty.public ModifyRequest(DN dn, java.util.List<Modification> mods)
dn
- The DN of the entry to modify. It must not be null
.mods
- The set of modifications to apply to the entry. It must not
be null
or empty.public ModifyRequest(java.lang.String dn, Modification mod, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mod
- The modification to apply to the entry. It must not be
null
.controls
- The set of controls to include in the request.public ModifyRequest(java.lang.String dn, Modification[] mods, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mods
- The set of modifications to apply to the entry. It must
not be null
or empty.controls
- The set of controls to include in the request.public ModifyRequest(java.lang.String dn, java.util.List<Modification> mods, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mods
- The set of modifications to apply to the entry. It must
not be null
or empty.controls
- The set of controls to include in the request.public ModifyRequest(DN dn, Modification mod, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mod
- The modification to apply to the entry. It must not be
null
.controls
- The set of controls to include in the request.public ModifyRequest(DN dn, Modification[] mods, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mods
- The set of modifications to apply to the entry. It must
not be null
or empty.controls
- The set of controls to include in the request.public ModifyRequest(DN dn, java.util.List<Modification> mods, Control[] controls)
dn
- The DN of the entry to modify. It must not be
null
.mods
- The set of modifications to apply to the entry. It must
not be null
or empty.controls
- The set of controls to include in the request.public ModifyRequest(java.lang.String... ldifModificationLines) throws LDIFException
ldifModificationLines
- The lines that comprise an LDIF
representation of a modify change record.
It must not be null
or empty.
LDIFException
- If the provided set of lines cannot be parsed as an
LDIF modify change record.Method Detail |
---|
public java.lang.String getDN()
getDN
in interface ReadOnlyModifyRequest
public void setDN(java.lang.String dn)
dn
- The DN of the entry to modify. It must not be null
.public void setDN(DN dn)
dn
- The DN of the entry to modify. It must not be null
.public java.util.List<Modification> getModifications()
getModifications
in interface ReadOnlyModifyRequest
public void addModification(Modification mod)
mod
- The modification to be added. It must not be null
.public boolean removeModification(Modification mod)
mod
- The modification to be removed. It must not be null
.
true
if the specified modification was found and removed,
or false
if not.public void setModifications(Modification mod)
mod
- The modification to use for this modify request. It must not
be null
.public void setModifications(Modification[] mods)
mods
- The set of modification to use for this modify request. It
must not be null
or empty.public void setModifications(java.util.List<Modification> mods)
mods
- The set of modification to use for this modify request. It
must not be null
or empty.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public void writeTo(ASN1Buffer writer)
writeTo
in interface ProtocolOp
writer
- The ASN.1 buffer to which the encoded representation should
be written.public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
protected LDAPResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class LDAPRequest
connection
- The connection to use to communicate with the directory
server.depth
- The current referral depth for this request. It should
always be one for the initial request, and should only
be incremented when following referrals.
LDAPException
- If a problem occurs while sending the request or
reading the response.@InternalUseOnly public void responseReceived(LDAPResponse response) throws LDAPException
response
- The LDAP response that has been received from the server.
It may be null
if the connection has been closed
without having received any response.
LDAPException
- If a problem occurs while handling the response.public int getLastMessageID()
getLastMessageID
in class LDAPRequest
public OperationType getOperationType()
getOperationType
in class LDAPRequest
public ModifyRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in interface ReadOnlyModifyRequest
public ModifyRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in interface ReadOnlyModifyRequest
controls
- The set of controls to include in the duplicate request.
public LDIFModifyChangeRecord toLDIFChangeRecord()
toLDIFChangeRecord
in interface ReadOnlyModifyRequest
public java.lang.String[] toLDIF()
toLDIF
in interface ReadOnlyModifyRequest
public java.lang.String toLDIFString()
toLDIFString
in interface ReadOnlyModifyRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class LDAPRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |