Package com.unboundid.ldap.sdk
Interface ReadOnlyDeleteRequest
-
- All Superinterfaces:
ReadOnlyLDAPRequest
,java.io.Serializable
- All Known Implementing Classes:
DeleteRequest
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlyDeleteRequest extends ReadOnlyLDAPRequest
This interface defines a set of methods that may be safely called in an LDAP delete request without altering its contents. This interface must not be implemented by any class other thanDeleteRequest
.
This interface does not inherently provide the assurance of thread safety for the methods that it exposes, because it is still possible for a thread referencing the object which implements this interface to alter the request using methods not included in this interface. However, if it can be guaranteed that no thread will alter the underlying object, then the methods exposed by this interface can be safely invoked concurrently by any number of threads.
-
-
Method Summary
All Methods Instance Methods Abstract 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.java.lang.String
getDN()
Retrieves the DN of the entry to delete.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.-
Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest
followReferrals, getControl, getControlList, getControls, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, toCode, toString, toString
-
-
-
-
Method Detail
-
getDN
@NotNull java.lang.String getDN()
Retrieves the DN of the entry to delete.- Returns:
- The DN of the entry to delete.
-
duplicate
@NotNull DeleteRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
@NotNull 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 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 LDIFDeleteChangeRecord toLDIFChangeRecord()
Retrieves an LDIF delete change record with the contents of this delete request.- Returns:
- An LDIF delete change record with the contents of this delete request.
-
toLDIF
@NotNull java.lang.String[] toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding delete change record.- Returns:
- A string array whose lines contain an LDIF representation of the corresponding delete change record.
-
toLDIFString
@NotNull java.lang.String toLDIFString()
Retrieves an LDIF string representation of this delete request.- Returns:
- An LDIF string representation of this delete request.
-
-