org.apache.directory.shared.ldap.message
Class LdapResultImpl

java.lang.Object
  org.apache.directory.shared.ldap.message.LdapResultImpl

All Implemented Interfaces:

InternalLdapResult

public class LdapResultImpl
extends java.lang.Object
implements InternalLdapResult

LdapResult implementation.

Version:

$Revision: 764131 $

Author:

Apache Directory Project

Constructor Summary

LdapResultImpl()

Method Summary

boolean	equals(java.lang.Object obj)
java.lang.String	getErrorMessage() Gets the descriptive error message associated with the error code.
LdapDN	getMatchedDn() Gets the lowest entry in the directory that was matched.
InternalReferral	getReferral() Gets the Referral associated with this LdapResult if the resultCode property is set to the REFERRAL ResultCodeEnum.
ResultCodeEnum	getResultCode() Gets the result code enumeration associated with the response.
boolean	isReferral() Gets whether or not this result represents a Referral.
void	setErrorMessage(java.lang.String errorMessage) Sets the descriptive error message associated with the error code.
void	setMatchedDn(LdapDN matchedDn) Sets the lowest entry in the directory that was matched.
void	setReferral(InternalReferral referral) Sets the Referral associated with this LdapResult if the resultCode property is set to the REFERRAL ResultCodeEnum.
void	setResultCode(ResultCodeEnum resultCode) Sets the result code enumeration associated with the response.
java.lang.String	toString() Get a String representation of a LdapResult

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapResultImpl

public LdapResultImpl()

Method Detail

getErrorMessage

public java.lang.String getErrorMessage()

Gets the descriptive error message associated with the error code. May be null for SUCCESS, COMPARETRUE, COMPAREFALSE and REFERRAL operations.

Specified by:

getErrorMessage in interface InternalLdapResult

Returns:

the descriptive error message.

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

Sets the descriptive error message associated with the error code. May be null for SUCCESS, COMPARETRUE, and COMPAREFALSE operations.

Specified by:

setErrorMessage in interface InternalLdapResult

Parameters:

errorMessage - the descriptive error message.

getMatchedDn

public LdapDN getMatchedDn()

Gets the lowest entry in the directory that was matched. For result codes of noSuchObject, aliasProblem, invalidDNSyntax and aliasDereferencingProblem, the matchedDN field is set to the name of the lowest entry (object or alias) in the directory that was matched. If no aliases were dereferenced while attempting to locate the entry, this will be a truncated form of the name provided, or if aliases were dereferenced, of the resulting name, as defined in section 12.5 of X.511 [8]. The matchedDN field is to be set to a zero length string with all other result codes.

Specified by:

getMatchedDn in interface InternalLdapResult

Returns:

the Dn of the lowest matched entry.

setMatchedDn

public void setMatchedDn(LdapDN matchedDn)

Sets the lowest entry in the directory that was matched.

Specified by:

setMatchedDn in interface InternalLdapResult

Parameters:

matchedDn - the Dn of the lowest matched entry.

See Also:

getMatchedDn()

getResultCode

public ResultCodeEnum getResultCode()

Gets the result code enumeration associated with the response. Corresponds to the resultCode field within the LDAPResult ASN.1 structure.

Specified by:

getResultCode in interface InternalLdapResult

Returns:

the result code enum value.

setResultCode

public void setResultCode(ResultCodeEnum resultCode)

Sets the result code enumeration associated with the response. Corresponds to the resultCode field within the LDAPResult ASN.1 structure.

Specified by:

setResultCode in interface InternalLdapResult

Parameters:

resultCode - the result code enum value.

getReferral

public InternalReferral getReferral()

Gets the Referral associated with this LdapResult if the resultCode property is set to the REFERRAL ResultCodeEnum.

Specified by:

getReferral in interface InternalLdapResult

Returns:

the referral on REFERRAL errors, null on all others.

isReferral

public boolean isReferral()

Gets whether or not this result represents a Referral. For referrals the error code is set to REFERRAL and the referral property is not null.

Specified by:

isReferral in interface InternalLdapResult

Returns:

true if this result represents a referral.

setReferral

public void setReferral(InternalReferral referral)

Sets the Referral associated with this LdapResult if the resultCode property is set to the REFERRAL ResultCodeEnum. Setting this property will result in a true return from isReferral and the resultCode should be set to REFERRAL.

Specified by:

setReferral in interface InternalLdapResult

Parameters:

referral - optional referral on REFERRAL errors.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

Parameters:

obj - The object to compare with

Returns:

true if both objects are equals

toString

public java.lang.String toString()

Get a String representation of a LdapResult

Overrides:

toString in class java.lang.Object

Returns:

A LdapResult String