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

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.LdapResultImpl
All Implemented Interfaces:
LdapResult

public class LdapResultImpl
extends java.lang.Object
implements LdapResult

LdapResult implementation.

Version:
$Revision: 379008 $
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.
 java.lang.String getMatchedDn()
          Gets the lowest entry in the directory that was matched.
 Referral 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(java.lang.String matchedDn)
          Sets the lowest entry in the directory that was matched.
 void setReferral(Referral 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 LdapResult
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 LdapResult
Parameters:
errorMessage - the descriptive error message.

getMatchedDn

public java.lang.String 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 LdapResult
Returns:
the Dn of the lowest matched entry.

setMatchedDn

public void setMatchedDn(java.lang.String matchedDn)
Sets the lowest entry in the directory that was matched.

Specified by:
setMatchedDn in interface LdapResult
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 LdapResult
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 LdapResult
Parameters:
resultCode - the result code enum value.

getReferral

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

Specified by:
getReferral in interface LdapResult
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 LdapResult
Returns:
true if this result represents a referral.

setReferral

public void setReferral(Referral 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 LdapResult
Parameters:
referral - optional referral on REFERRAL errors.

equals

public boolean equals(java.lang.Object obj)
Parameters:
obj -
Returns:

toString

public java.lang.String toString()
Get a String representation of a LdapResult

Returns:
A LdapResult String


Copyright © 2003-2006 . All Rights Reserved.