Package org.ldaptive

Class CompareRequest

java.lang.Object

org.ldaptive.AbstractRequestMessage

org.ldaptive.CompareRequest

All Implemented Interfaces:

Request

public class CompareRequest
extends AbstractRequestMessage

LDAP compare request defined as:

   CompareRequest ::= [APPLICATION 14] SEQUENCE {
     entry           LDAPDN,
     ava             AttributeValueAssertion }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompareRequest.Builder	Compare request builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage

AbstractRequestMessage.AbstractBuilder<B,T extends AbstractRequestMessage>

Field Summary

Fields

Modifier and Type	Field	Description
private String	assertionValue	Assertion value.
private String	attributeDesc	Attribute description
private String	ldapDn	LDAP DN to compare.
static final int	PROTOCOL_OP	BER protocol number.

Fields inherited from class org.ldaptive.AbstractRequestMessage

logger

Constructor Summary

Constructors

Constructor	Description
CompareRequest()	Default constructor.
CompareRequest(String dn, String name, String value)	Creates a new compare request.

Method Summary

Modifier and Type	Method	Description
static CompareRequest.Builder	builder()	Creates a builder for this class.
String	getDn()	Returns the DN.
String	getName()	Returns the name.
protected DEREncoder[]	getRequestEncoders(int id)	Returns the request encoders for this message.
String	getValue()	Returns the value.
void	setDn(String dn)	Sets the DN.
void	setName(String name)	Sets the name.
void	setValue(String value)	Sets the value.
String	toString()

Methods inherited from class org.ldaptive.AbstractRequestMessage

encode, getControls, getResponseTimeout, setControls, setResponseTimeout

Methods inherited from class java.lang.Object

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

Field Details

PROTOCOL_OP

public static final int PROTOCOL_OP

BER protocol number.

See Also:

• Constant Field Values

ldapDn

private String ldapDn

LDAP DN to compare.

attributeDesc

private String attributeDesc

Attribute description

assertionValue

private String assertionValue

Assertion value.

Constructor Details

CompareRequest

public CompareRequest()

Default constructor.

CompareRequest

public CompareRequest(String dn,
 String name,
 String value)

Creates a new compare request.

Parameters:

dn - to compare

name - attribute description

value - assertion value

Method Details

getDn

public String getDn()

Returns the DN.

Returns:

DN

setDn

public void setDn(String dn)

Sets the DN.

Parameters:

dn - ldapDn to set

getName

public String getName()

Returns the name.

Returns:

name

setName

public void setName(String name)

Sets the name.

Parameters:

name - attributeDesc to set

getValue

public String getValue()

Returns the value.

Returns:

value

setValue

public void setValue(String value)

Sets the value.

Parameters:

value - assertionValue to set

getRequestEncoders

protected DEREncoder[] getRequestEncoders(int id)

Description copied from class: AbstractRequestMessage

Returns the request encoders for this message.

Specified by:

getRequestEncoders in class AbstractRequestMessage

Parameters:

id - message ID

Returns:

request encoders

toString

public String toString()

Overrides:

toString in class AbstractRequestMessage

builder

public static CompareRequest.Builder builder()

Creates a builder for this class.

Returns:

new builder