public class LdapResult extends Object
The LDAPResult is the construct used in this protocol to return success or failure indications from servers to clients. In response to various requests servers will return responses containing fields of type LDAPResult to indicate the final status of a protocol operation request.
Constructor and Description |
---|
LdapResult() |
Modifier and Type | Method and Description |
---|---|
String |
getErrorMessage()
Gets the descriptive error message associated with the error code.
|
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.
|
org.apache.directory.shared.ldap.message.ResultCodeEnum |
getResultCode()
Gets the result code enumeration associated with the response.
|
boolean |
isReferral()
Gets whether or not this result represents a Referral.
|
void |
setErrorMessage(String errorMessage)
Sets the descriptive error message associated with the error code.
|
void |
setMatchedDn(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(org.apache.directory.shared.ldap.message.ResultCodeEnum resultCode)
Sets the result code enumeration associated with the response.
|
public String getErrorMessage()
public void setErrorMessage(String errorMessage)
errorMessage
- the descriptive error message.public String getMatchedDn()
public void setMatchedDn(String matchedDn)
dn
- the Dn of the lowest matched entry.getMatchedDn()
public org.apache.directory.shared.ldap.message.ResultCodeEnum getResultCode()
public void setResultCode(org.apache.directory.shared.ldap.message.ResultCodeEnum resultCode)
resultCode
- the result code enum value.public Referral getReferral()
public boolean isReferral()
public void setReferral(Referral referral)
referral
- optional referral on REFERRAL errors.Copyright © 2009–2013 The Apache Software Foundation. All rights reserved.