Package org.opends.server.protocols.ldap

Class CompareRequestProtocolOp

java.lang.Object

org.opends.server.protocols.ldap.ProtocolOp

org.opends.server.protocols.ldap.CompareRequestProtocolOp

public class CompareRequestProtocolOp
extends ProtocolOp

This class defines the structures and methods for an LDAP compare request protocol op, which is used to determine whether a particular entry contains a specified attribute value.

Constructor Summary

Constructors

Constructor	Description
CompareRequestProtocolOp(ByteString dn, String attributeType, ByteString assertionValue)	Creates a new compare request protocol op with the provided information.

Method Summary

Modifier and Type	Method	Description
ByteString	getAssertionValue()	Retrieves the assertion value for this compare request.
String	getAttributeType()	Retrieves the attribute type for this compare request.
ByteString	getDN()	Retrieves the DN for this compare request.
String	getProtocolOpName()	Retrieves the name for this protocol op type.
byte	getType()	Retrieves the BER type for this protocol op.
void	toString(StringBuilder buffer)	Appends a string representation of this LDAP protocol op to the provided buffer.
void	toString(StringBuilder buffer, int indent)	Appends a multi-line string representation of this LDAP protocol op to the provided buffer.
void	write(ASN1Writer stream)	Writes this protocol op to an ASN.1 output stream.

Methods inherited from class org.opends.server.protocols.ldap.ProtocolOp

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompareRequestProtocolOp

public CompareRequestProtocolOp(ByteString dn,
                                String attributeType,
                                ByteString assertionValue)

Creates a new compare request protocol op with the provided information.

Parameters:

dn - The DN for this compare request.

attributeType - The attribute type for this compare request.

assertionValue - The assertion value for this compare request.

Method Detail

getDN

public ByteString getDN()

Retrieves the DN for this compare request.

Returns:

The DN for this compare request.

getAttributeType

public String getAttributeType()

Retrieves the attribute type for this compare request.

Returns:

The attribute type for this compare request.

getAssertionValue

public ByteString getAssertionValue()

Retrieves the assertion value for this compare request.

Returns:

The assertion value for this compare request.

getType

public byte getType()

Retrieves the BER type for this protocol op.

Specified by:

getType in class ProtocolOp

Returns:

The BER type for this protocol op.

getProtocolOpName

public String getProtocolOpName()

Retrieves the name for this protocol op type.

Specified by:

getProtocolOpName in class ProtocolOp

Returns:

The name for this protocol op type.

write

public void write(ASN1Writer stream)
           throws IOException

Writes this protocol op to an ASN.1 output stream.

Specified by:

write in class ProtocolOp

Parameters:

stream - The ASN.1 output stream to write to.

Throws:

IOException - If a problem occurs while writing to the stream.

toString

public void toString(StringBuilder buffer)

Appends a string representation of this LDAP protocol op to the provided buffer.

Specified by:

toString in class ProtocolOp

Parameters:

buffer - The buffer to which the string should be appended.

toString

public void toString(StringBuilder buffer,
                     int indent)

Appends a multi-line string representation of this LDAP protocol op to the provided buffer.

Specified by:

toString in class ProtocolOp

Parameters:

buffer - The buffer to which the information should be appended.

indent - The number of spaces from the margin that the lines should be indented.