@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class CompareRequest extends UpdatableLDAPRequest implements ReadOnlyCompareRequest, ProtocolOp
CompareRequest
objects are mutable and therefore can be altered and
re-used for multiple requests. Note, however, that CompareRequest
objects are not threadsafe and therefore a single CompareRequest
object instance should not be used to process multiple requests at the same
time.
CompareRequest compareRequest = new CompareRequest("dc=example,dc=com", "description", "test"); CompareResult compareResult; try { compareResult = connection.compare(compareRequest); // The compare operation didn't throw an exception, so we can try to // determine whether the compare matched. if (compareResult.compareMatched()) { // The entry does have a description value of test. } else { // The entry does not have a description value of test. } } catch (LDAPException le) { // The compare operation failed. compareResult = new CompareResult(le.toLDAPResult()); ResultCode resultCode = le.getResultCode(); String errorMessageFromServer = le.getDiagnosticMessage(); }
Constructor and Description |
---|
CompareRequest(DN dn,
java.lang.String attributeName,
ASN1OctetString assertionValue,
Control[] controls)
Creates a new compare request with the provided information.
|
CompareRequest(DN dn,
java.lang.String attributeName,
byte[] assertionValue)
Creates a new compare request with the provided information.
|
CompareRequest(DN dn,
java.lang.String attributeName,
byte[] assertionValue,
Control[] controls)
Creates a new compare request with the provided information.
|
CompareRequest(DN dn,
java.lang.String attributeName,
java.lang.String assertionValue)
Creates a new compare request with the provided information.
|
CompareRequest(DN dn,
java.lang.String attributeName,
java.lang.String assertionValue,
Control[] controls)
Creates a new compare request with the provided information.
|
CompareRequest(java.lang.String dn,
java.lang.String attributeName,
byte[] assertionValue)
Creates a new compare request with the provided information.
|
CompareRequest(java.lang.String dn,
java.lang.String attributeName,
byte[] assertionValue,
Control[] controls)
Creates a new compare request with the provided information.
|
CompareRequest(java.lang.String dn,
java.lang.String attributeName,
java.lang.String assertionValue)
Creates a new compare request with the provided information.
|
CompareRequest(java.lang.String dn,
java.lang.String attributeName,
java.lang.String assertionValue,
Control[] controls)
Creates a new compare request with the provided information.
|
Modifier and Type | Method and Description |
---|---|
CompareRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
CompareRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
ASN1Element |
encodeProtocolOp()
Encodes the compare request protocol op to an ASN.1 element.
|
java.lang.String |
getAssertionValue()
Retrieves the assertion value to verify within the target entry.
|
byte[] |
getAssertionValueBytes()
Retrieves the assertion value to verify within the target entry, formatted
as a byte array.
|
java.lang.String |
getAttributeName()
Retrieves the name of the attribute for which the comparison is to be
performed.
|
java.lang.String |
getDN()
Retrieves the DN of the entry in which the comparison is to be performed.
|
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.
|
ASN1OctetString |
getRawAssertionValue()
Retrieves the assertion value to verify within the target entry.
|
protected CompareResult |
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)
Indicates that the provided LDAP response has been received by from the
server.
|
void |
setAssertionValue(ASN1OctetString assertionValue)
Specifies the assertion value to specify within the target entry.
|
void |
setAssertionValue(byte[] assertionValue)
Specifies the assertion value to specify within the target entry.
|
void |
setAssertionValue(java.lang.String assertionValue)
Specifies the assertion value to specify within the target entry.
|
void |
setAttributeName(java.lang.String attributeName)
Specifies the name of the attribute for which the comparison is to be
performed.
|
void |
setDN(DN dn)
Specifies the DN of the entry in which the comparison is to be performed.
|
void |
setDN(java.lang.String dn)
Specifies the DN of the entry in which the comparison is to be performed.
|
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.
|
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.
|
addControl, addControls, clearControls, removeControl, removeControl, replaceControl, replaceControl, setControls, setControls
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toString
public CompareRequest(java.lang.String dn, java.lang.String attributeName, java.lang.String assertionValue)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.public CompareRequest(java.lang.String dn, java.lang.String attributeName, byte[] assertionValue)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.public CompareRequest(DN dn, java.lang.String attributeName, java.lang.String assertionValue)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.public CompareRequest(DN dn, java.lang.String attributeName, byte[] assertionValue)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.public CompareRequest(java.lang.String dn, java.lang.String attributeName, java.lang.String assertionValue, Control[] controls)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.controls
- The set of controls for this compare request.public CompareRequest(java.lang.String dn, java.lang.String attributeName, byte[] assertionValue, Control[] controls)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.controls
- The set of controls for this compare request.public CompareRequest(DN dn, java.lang.String attributeName, java.lang.String assertionValue, Control[] controls)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.controls
- The set of controls for this compare request.public CompareRequest(DN dn, java.lang.String attributeName, ASN1OctetString assertionValue, Control[] controls)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.controls
- The set of controls for this compare request.public CompareRequest(DN dn, java.lang.String attributeName, byte[] assertionValue, Control[] controls)
dn
- The DN of the entry in which the comparison is to
be performed. It must not be null
.attributeName
- The name of the target attribute for which the
comparison is to be performed. It must not be
null
.assertionValue
- The assertion value to verify within the entry. It
must not be null
.controls
- The set of controls for this compare request.public java.lang.String getDN()
getDN
in interface ReadOnlyCompareRequest
public void setDN(java.lang.String dn)
dn
- The DN of the entry in which the comparison is to be performed.
It must not be null
.public void setDN(DN dn)
dn
- The DN of the entry in which the comparison is to be performed.
It must not be null
.public java.lang.String getAttributeName()
getAttributeName
in interface ReadOnlyCompareRequest
public void setAttributeName(java.lang.String attributeName)
attributeName
- The name of the attribute for which the comparison
is to be performed. It must not be null
.public java.lang.String getAssertionValue()
getAssertionValue
in interface ReadOnlyCompareRequest
public byte[] getAssertionValueBytes()
getAssertionValueBytes
in interface ReadOnlyCompareRequest
public ASN1OctetString getRawAssertionValue()
getRawAssertionValue
in interface ReadOnlyCompareRequest
public void setAssertionValue(java.lang.String assertionValue)
assertionValue
- The assertion value to specify within the target
entry. It must not be null
.public void setAssertionValue(byte[] assertionValue)
assertionValue
- The assertion value to specify within the target
entry. It must not be null
.public void setAssertionValue(ASN1OctetString assertionValue)
assertionValue
- The assertion value to specify within the target
entry. It must not be null
.public byte getProtocolOpType()
getProtocolOpType
in interface ProtocolOp
public void writeTo(ASN1Buffer buffer)
writeTo
in interface ProtocolOp
buffer
- The ASN.1 buffer to which the encoded representation should
be written.public ASN1Element encodeProtocolOp()
encodeProtocolOp
in interface ProtocolOp
protected CompareResult 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 CompareRequest duplicate()
duplicate
in interface ReadOnlyCompareRequest
duplicate
in interface ReadOnlyLDAPRequest
public CompareRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyCompareRequest
duplicate
in interface ReadOnlyLDAPRequest
controls
- The set of controls to include in the duplicate request.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.public void toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing)
toCode
in interface ReadOnlyLDAPRequest
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 is null
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 (if true
),
or just to generate the request (if
false
).