com.unboundid.ldap.sdk

Interface ReadOnlyAddRequest

All Superinterfaces:

ReadOnlyLDAPRequest, java.io.Serializable

All Known Implementing Classes:

AddRequest

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

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

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
AddRequest	duplicate() Creates a new instance of this LDAP request that may be modified without impacting this request.
AddRequest	duplicate(Control[] controls) Creates a new instance of this LDAP request that may be modified without impacting this request.
Attribute	getAttribute(java.lang.String attributeName) Retrieves the specified attribute from this add request.
java.util.List<Attribute>	getAttributes() Retrieves the set of attributes for this add request.
java.lang.String	getDN() Retrieves the DN for this add request.
boolean	hasAttribute(Attribute attribute) Indicates whether this add request contains the specified attribute.
boolean	hasAttribute(java.lang.String attributeName) Indicates whether this add request contains the specified attribute.
boolean	hasAttributeValue(java.lang.String attributeName, byte[] attributeValue) Indicates whether this add request contains an attribute with the given name and value.
boolean	hasAttributeValue(java.lang.String attributeName, byte[] attributeValue, MatchingRule matchingRule) Indicates whether this add request contains an attribute with the given name and value.
boolean	hasAttributeValue(java.lang.String attributeName, java.lang.String attributeValue) Indicates whether this add request contains an attribute with the given name and value.
boolean	hasAttributeValue(java.lang.String attributeName, java.lang.String attributeValue, MatchingRule matchingRule) Indicates whether this add request contains an attribute with the given name and value.
boolean	hasObjectClass(java.lang.String objectClassName) Indicates whether this add request contains the specified object class.
Entry	toEntry() Retrieves an Entry object containing the DN and attributes of this add request.
java.lang.String[]	toLDIF() Retrieves a string array whose lines contain an LDIF representation of the corresponding add change record.
LDIFAddChangeRecord	toLDIFChangeRecord() Retrieves an LDIF add change record with the contents of this add request.
java.lang.String	toLDIFString() Retrieves an LDIF string representation of this add 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 for this add request.

Returns:

The DN for this add request.

getAttributes

@NotNull
java.util.List<Attribute> getAttributes()

Retrieves the set of attributes for this add request.

Returns:

The set of attributes for this add request.

getAttribute

@Nullable
Attribute getAttribute(@NotNull
                                 java.lang.String attributeName)

Retrieves the specified attribute from this add request.

Parameters:

attributeName - The name of the attribute to retrieve. It must not be null.

Returns:

The requested attribute, or null if it does not exist in the add request.

hasAttribute

boolean hasAttribute(@NotNull
                     java.lang.String attributeName)

Indicates whether this add request contains the specified attribute.

Parameters:

attributeName - The name of the attribute for which to make the determination. It must not be null.

Returns:

true if this add request contains the specified attribute, or false if not.

hasAttribute

boolean hasAttribute(@NotNull
                     Attribute attribute)

Indicates whether this add request contains the specified attribute. It will only return true if this add request contains an attribute with the same name and exact set of values.

Parameters:

attribute - The attribute for which to make the determination. It must not be null.

Returns:

true if this add request contains the specified attribute, or false if not.

hasAttributeValue

boolean hasAttributeValue(@NotNull
                          java.lang.String attributeName,
                          @NotNull
                          java.lang.String attributeValue)

Indicates whether this add request contains an attribute with the given name and value.

Parameters:

attributeName - The name of the attribute for which to make the determination. It must not be null.

attributeValue - The value for which to make the determination. It must not be null.

Returns:

true if this add request contains an attribute with the specified name and value, or false if not.

hasAttributeValue

boolean hasAttributeValue(@NotNull
                          java.lang.String attributeName,
                          @NotNull
                          java.lang.String attributeValue,
                          @NotNull
                          MatchingRule matchingRule)

Indicates whether this add request contains an attribute with the given name and value.

Parameters:

attributeName - The name of the attribute for which to make the determination. It must not be null.

attributeValue - The value for which to make the determination. It must not be null.

matchingRule - The matching rule to use to make the determination. It must not be null.

Returns:

true if this add request contains an attribute with the specified name and value, or false if not.

hasAttributeValue

boolean hasAttributeValue(@NotNull
                          java.lang.String attributeName,
                          @NotNull
                          byte[] attributeValue)

Indicates whether this add request contains an attribute with the given name and value.

Parameters:

attributeName - The name of the attribute for which to make the determination. It must not be null.

attributeValue - The value for which to make the determination. It must not be null.

Returns:

true if this add request contains an attribute with the specified name and value, or false if not.

hasAttributeValue

boolean hasAttributeValue(@NotNull
                          java.lang.String attributeName,
                          @NotNull
                          byte[] attributeValue,
                          @NotNull
                          MatchingRule matchingRule)

Indicates whether this add request contains an attribute with the given name and value.

Parameters:

attributeName - The name of the attribute for which to make the determination. It must not be null.

attributeValue - The value for which to make the determination. It must not be null.

matchingRule - The matching rule to use to make the determination. It must not be null.

Returns:

true if this add request contains an attribute with the specified name and value, or false if not.

hasObjectClass

boolean hasObjectClass(@NotNull
                       java.lang.String objectClassName)

Indicates whether this add request contains the specified object class.

Parameters:

objectClassName - The name of the object class for which to make the determination. It must not be null.

Returns:

true if this add request contains the specified object class, or false if not.

toEntry

@NotNull
Entry toEntry()

Retrieves an Entry object containing the DN and attributes of this add request.

Returns:

An Entry object containing the DN and attributes of this add request.

duplicate

@NotNull
AddRequest 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
AddRequest 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
LDIFAddChangeRecord toLDIFChangeRecord()

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

Returns:

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

toLDIF

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

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

Returns:

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

toLDIFString

@NotNull
java.lang.String toLDIFString()

Retrieves an LDIF string representation of this add request.

Returns:

An LDIF string representation of this add request.