Package com.unboundid.ldap.protocol
Class CompareRequestProtocolOp
- java.lang.Object
-
- com.unboundid.ldap.protocol.CompareRequestProtocolOp
-
- All Implemented Interfaces:
ProtocolOp
,java.io.Serializable
@InternalUseOnly @NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CompareRequestProtocolOp extends java.lang.Object implements ProtocolOp
This class provides an implementation of an LDAP compare request protocol op.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CompareRequestProtocolOp(CompareRequest request)
Creates a new compare request protocol op from the provided compare request object.CompareRequestProtocolOp(java.lang.String dn, java.lang.String attributeName, ASN1OctetString assertionValue)
Creates a new compare request protocol op with the provided information.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CompareRequestProtocolOp
decodeProtocolOp(ASN1Element element)
Decodes the provided ASN.1 element as a compare request protocol op.ASN1Element
encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.ASN1OctetString
getAssertionValue()
Retrieves the assertion value for this compare request.java.lang.String
getAttributeName()
Retrieves the attribute name for this compare request.java.lang.String
getDN()
Retrieves the DN for this compare request.byte
getProtocolOpType()
Retrieves the BER type for this protocol op.CompareRequest
toCompareRequest(Control... controls)
Creates a compare request from this protocol op.java.lang.String
toString()
Retrieves a string representation of this protocol op.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op 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.
-
-
-
Constructor Detail
-
CompareRequestProtocolOp
public CompareRequestProtocolOp(java.lang.String dn, java.lang.String attributeName, ASN1OctetString assertionValue)
Creates a new compare request protocol op with the provided information.- Parameters:
dn
- The DN for this compare request.attributeName
- The attribute name for this compare request.assertionValue
- The assertion value for this compare request.
-
CompareRequestProtocolOp
public CompareRequestProtocolOp(CompareRequest request)
Creates a new compare request protocol op from the provided compare request object.- Parameters:
request
- The compare request object to use to create this protocol op.
-
-
Method Detail
-
getDN
public java.lang.String getDN()
Retrieves the DN for this compare request.- Returns:
- The DN for this compare request.
-
getAttributeName
public java.lang.String getAttributeName()
Retrieves the attribute name for this compare request.- Returns:
- The attribute name for this compare request.
-
getAssertionValue
public ASN1OctetString getAssertionValue()
Retrieves the assertion value for this compare request.- Returns:
- The assertion value for this compare request.
-
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.
-
encodeProtocolOp
public ASN1Element encodeProtocolOp()
Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.- Specified by:
encodeProtocolOp
in interfaceProtocolOp
- Returns:
- The ASN.1 element containing the encoded protocol op.
-
decodeProtocolOp
public static CompareRequestProtocolOp decodeProtocolOp(ASN1Element element) throws LDAPException
Decodes the provided ASN.1 element as a compare request protocol op.- Parameters:
element
- The ASN.1 element to be decoded.- Returns:
- The decoded compare request protocol op.
- Throws:
LDAPException
- If the provided ASN.1 element cannot be decoded as a compare request protocol op.
-
writeTo
public void writeTo(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.
-
toCompareRequest
public CompareRequest toCompareRequest(Control... controls)
Creates a compare request from this protocol op.- Parameters:
controls
- The set of controls to include in the compare request. It may be empty ornull
if no controls should be included.- Returns:
- The compare request that was created.
-
toString
public java.lang.String toString()
Retrieves a string representation of this protocol op.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this protocol op.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this LDAP protocol op to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Parameters:
buffer
- The buffer to which the string representation should be appended.
-
-