Package com.unboundid.ldap.sdk
Class DeleteRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.UpdatableLDAPRequest
-
- com.unboundid.ldap.sdk.DeleteRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyDeleteRequest
,ReadOnlyLDAPRequest
,java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class DeleteRequest extends UpdatableLDAPRequest implements ReadOnlyDeleteRequest, ProtocolOp
This class implements the processing necessary to perform an LDAPv3 delete operation, which removes an entry from the directory. A delete request contains the DN of the entry to remove. It may also include a set of controls to send to the server.DeleteRequest
objects are mutable and therefore can be altered and re-used for multiple requests. Note, however, thatDeleteRequest
objects are not threadsafe and therefore a singleDeleteRequest
object instance should not be used to process multiple requests at the same time.
Example
The following example demonstrates the process for performing a delete operation:DeleteRequest deleteRequest = new DeleteRequest("cn=entry to delete,dc=example,dc=com"); LDAPResult deleteResult; try { deleteResult = connection.delete(deleteRequest); // If we get here, the delete was successful. } catch (LDAPException le) { // The delete operation failed. deleteResult = le.toLDAPResult(); ResultCode resultCode = le.getResultCode(); String errorMessageFromServer = le.getDiagnosticMessage(); }
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DeleteRequest(DN dn)
Creates a new delete request with the provided DN.DeleteRequest(DN dn, Control[] controls)
Creates a new delete request with the provided DN.DeleteRequest(java.lang.String dn)
Creates a new delete request with the provided DN.DeleteRequest(java.lang.String dn, Control[] controls)
Creates a new delete request with the provided DN.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DeleteRequest
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.DeleteRequest
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request.ASN1Element
encodeProtocolOp()
Encodes the delete request protocol op to an ASN.1 element.java.lang.String
getDN()
Retrieves the DN of the entry to delete.int
getLastMessageID()
Retrieves the message ID for the last LDAP message sent using this 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 delete request to the directory server over the provided connection and returns the associated response.void
responseReceived(LDAPResponse response)
void
setDN(DN dn)
Specifies the DN of the entry to delete.void
setDN(java.lang.String dn)
Specifies the DN of the entry to delete.void
toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing)
Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.java.lang.String[]
toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding delete change record.LDIFDeleteChangeRecord
toLDIFChangeRecord()
Retrieves an LDIF delete change record with the contents of this delete request.java.lang.String
toLDIFString()
Retrieves an LDIF string representation of this delete request.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.void
writeTo(ASN1Buffer buffer)
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, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, 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, getControls, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, toString
-
-
-
-
Constructor Detail
-
DeleteRequest
public DeleteRequest(@NotNull java.lang.String dn)
Creates a new delete request with the provided DN.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.
-
DeleteRequest
public DeleteRequest(@NotNull java.lang.String dn, @Nullable Control[] controls)
Creates a new delete request with the provided DN.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.controls
- The set of controls to include in the request.
-
DeleteRequest
public DeleteRequest(@NotNull DN dn)
Creates a new delete request with the provided DN.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.
-
DeleteRequest
public DeleteRequest(@NotNull DN dn, @Nullable Control[] controls)
Creates a new delete request with the provided DN.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.controls
- The set of controls to include in the request.
-
-
Method Detail
-
getDN
@NotNull public java.lang.String getDN()
Retrieves the DN of the entry to delete.- Specified by:
getDN
in interfaceReadOnlyDeleteRequest
- Returns:
- The DN of the entry to delete.
-
setDN
public void setDN(@NotNull java.lang.String dn)
Specifies the DN of the entry to delete.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.
-
setDN
public void setDN(@NotNull DN dn)
Specifies the DN of the entry to delete.- Parameters:
dn
- The DN of the entry to delete. It must not benull
.
-
getProtocolOpType
public byte getProtocolOpType()
Retrieves the BER type for this protocol op.- Specified by:
getProtocolOpType
in interfaceProtocolOp
- Returns:
- The BER type for this protocol op.
-
writeTo
public void writeTo(@NotNull ASN1Buffer buffer)
Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.- Specified by:
writeTo
in interfaceProtocolOp
- Parameters:
buffer
- The ASN.1 buffer to which the encoded representation should be written.
-
encodeProtocolOp
@NotNull public ASN1Element encodeProtocolOp()
Encodes the delete request protocol op to an ASN.1 element.- Specified by:
encodeProtocolOp
in interfaceProtocolOp
- Returns:
- The ASN.1 element with the encoded delete request protocol op.
-
process
@NotNull protected LDAPResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
Sends this delete request to the directory server over the provided connection and returns the associated response.- Specified by:
process
in classLDAPRequest
- Parameters:
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.- Returns:
- An LDAP result object that provides information about the result of the delete processing.
- Throws:
LDAPException
- If a problem occurs while sending the request or reading the response.
-
responseReceived
@InternalUseOnly public void responseReceived(@NotNull LDAPResponse response) throws LDAPException
- Throws:
LDAPException
-
getLastMessageID
public int getLastMessageID()
Retrieves the message ID for the last LDAP message sent using this request.- Specified by:
getLastMessageID
in classLDAPRequest
- Returns:
- The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.
-
getOperationType
@NotNull public OperationType getOperationType()
Retrieves the type of operation that is represented by this request.- Specified by:
getOperationType
in classLDAPRequest
- Returns:
- The type of operation that is represented by this request.
-
duplicate
@NotNull public DeleteRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.- Specified by:
duplicate
in interfaceReadOnlyDeleteRequest
- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
@NotNull public DeleteRequest duplicate(@Nullable Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.- Specified by:
duplicate
in interfaceReadOnlyDeleteRequest
- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
toLDIFChangeRecord
@NotNull public LDIFDeleteChangeRecord toLDIFChangeRecord()
Retrieves an LDIF delete change record with the contents of this delete request.- Specified by:
toLDIFChangeRecord
in interfaceReadOnlyDeleteRequest
- Returns:
- An LDIF delete change record with the contents of this delete request.
-
toLDIF
@NotNull public java.lang.String[] toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding delete change record.- Specified by:
toLDIF
in interfaceReadOnlyDeleteRequest
- Returns:
- A string array whose lines contain an LDIF representation of the corresponding delete change record.
-
toLDIFString
@NotNull public java.lang.String toLDIFString()
Retrieves an LDIF string representation of this delete request.- Specified by:
toLDIFString
in interfaceReadOnlyDeleteRequest
- Returns:
- An LDIF string representation of this delete request.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Specified by:
toString
in classLDAPRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
toCode
public void toCode(@NotNull java.util.List<java.lang.String> lineList, @NotNull java.lang.String requestID, int indentSpaces, boolean includeProcessing)
Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.- Specified by:
toCode
in interfaceReadOnlyLDAPRequest
- Parameters:
lineList
- The list to which the source code lines should be added.requestID
- The name that should be used as an identifier for the request. If this isnull
or empty, then a generic ID will be used.indentSpaces
- The number of spaces that should be used to indent the generated code. It must not be negative.includeProcessing
- Indicates whether the generated code should include code required to actually process the request and handle the result (iftrue
), or just to generate the request (iffalse
).
-
-