org.ldaptive

Class CompareRequest

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.CompareRequest

All Implemented Interfaces:

Message<RequestControl>, Request

public class CompareRequest
extends AbstractRequest

Contains the data required to perform an ldap compare operation.

Field Summary

Fields

Modifier and Type	Field and Description
private LdapAttribute	attribute Attribute to compare.
private java.lang.String	compareDn DN to compare.

Constructor Summary

Constructors

Constructor and Description
CompareRequest() Default constructor.
CompareRequest(java.lang.String dn, LdapAttribute attr) Creates a new compare request.

Method Summary

Modifier and Type	Method and Description
LdapAttribute	getAttribute() Returns the attribute containing the value to compare.
java.lang.String	getDn() Returns the DN to compare.
void	setAttribute(LdapAttribute attr) Sets the attribute to compare.
void	setDn(java.lang.String dn) Sets the DN to compare.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

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

Field Detail

compareDn

private java.lang.String compareDn

DN to compare.

attribute

private LdapAttribute attribute

Attribute to compare.

Constructor Detail

CompareRequest

public CompareRequest()

Default constructor.

CompareRequest

public CompareRequest(java.lang.String dn,
                      LdapAttribute attr)

Creates a new compare request.

Parameters:

dn - containing the attribute to compare

attr - attribute to compare

Method Detail

getDn

public java.lang.String getDn()

Returns the DN to compare.

Returns:

DN

setDn

public void setDn(java.lang.String dn)

Sets the DN to compare.

Parameters:

dn - to compare

getAttribute

public LdapAttribute getAttribute()

Returns the attribute containing the value to compare. If this attribute contains multiple values, only the first value as return by the underlying collection is used.

Returns:

attribute to compare

setAttribute

public void setAttribute(LdapAttribute attr)

Sets the attribute to compare.

Parameters:

attr - attribute to compare

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object