com.unboundid.ldap.sdk

Interface ReadOnlyModifyRequest

All Superinterfaces:

ReadOnlyLDAPRequest, java.io.Serializable

All Known Implementing Classes:

ModifyRequest

@NotExtensible
 @ThreadSafety(level=INTERFACE_NOT_THREADSAFE)
public interface ReadOnlyModifyRequest
extends ReadOnlyLDAPRequest

This interface defines a set of methods that may be safely called in an LDAP modify request without altering its contents. This interface must not be implemented by any class other than ModifyRequest.

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

Modifier and Type	Method and Description
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.
java.lang.String	getDN() Retrieves the DN of the entry to modify.
java.util.List<Modification>	getModifications() Retrieves the set of modifications for this modify request.
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.

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 modify.

Returns:

The DN of the entry to modify.

getModifications

@NotNull
java.util.List<Modification> getModifications()

Retrieves the set of modifications for this modify request. The returned list must not be altered.

Returns:

The set of modifications for this modify request.

duplicate

@NotNull
ModifyRequest duplicate()

Creates a new instance of this LDAP request that may be modified without impacting this request.

Specified by:

duplicate in interface ReadOnlyLDAPRequest

Returns:

A new instance of this LDAP request that may be modified without impacting this request.

duplicate

@NotNull
ModifyRequest 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 interface ReadOnlyLDAPRequest

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
LDIFModifyChangeRecord toLDIFChangeRecord()

Retrieves an LDIF modify change record with the contents of this modify request.

Returns:

An LDIF modify change record with the contents of this modify request.

toLDIF

@NotNull
java.lang.String[] toLDIF()

Retrieves a string array whose lines contain an LDIF representation of the corresponding modify change record.

Returns:

A string array whose lines contain an LDIF representation of the corresponding modify change record.

toLDIFString

@NotNull
java.lang.String toLDIFString()

Retrieves an LDIF string representation of this modify request.

Returns:

An LDIF string representation of this modify request.