|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LdapResult
LDAPv3 result structure embedded into Responses. See section 4.1.10 in RFC 2251 for a description of the LDAPResult ASN.1 structure, here's a snippet from it:
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.
Method Summary | |
---|---|
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. |
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(LdapDN dn)
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. |
Method Detail |
---|
ResultCodeEnum getResultCode()
void setResultCode(ResultCodeEnum resultCode)
resultCode
- the result code enum value.LdapDN getMatchedDn()
void setMatchedDn(LdapDN dn)
dn
- the Dn of the lowest matched entry.getMatchedDn()
java.lang.String getErrorMessage()
void setErrorMessage(java.lang.String errorMessage)
errorMessage
- the descriptive error message.boolean isReferral()
Referral getReferral()
void setReferral(Referral referral)
referral
- optional referral on REFERRAL errors.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |