public interface LdapResult
The LDAPResult is the construct used in this protocol to return success or failure indications from servers to clients. To various requests, servers will return responses containing the elements found in LDAPResult to indicate the final status of the protocol operation request. LDAPResult ::= SEQUENCE { resultCode ENUMERATED { success (0), operationsError (1), protocolError (2), timeLimitExceeded (3), sizeLimitExceeded (4), compareFalse (5), compareTrue (6), authMethodNotSupported (7), strongerAuthRequired (8), -- 9 reserved -- referral (10), adminLimitExceeded (11), unavailableCriticalExtension (12), confidentialityRequired (13), saslBindInProgress (14), noSuchAttribute (16), undefinedAttributeType (17), inappropriateMatching (18), constraintViolation (19), attributeOrValueExists (20), invalidAttributeSyntax (21), -- 22-31 unused -- noSuchObject (32), aliasProblem (33), invalidDNSyntax (34), -- 35 reserved for undefined isLeaf -- aliasDereferencingProblem (36), -- 37-47 unused -- inappropriateAuthentication (48), invalidCredentials (49), insufficientAccessRights (50), busy (51), unavailable (52), unwillingToPerform (53), loopDetect (54), -- 55-63 unused -- namingViolation (64), objectClassViolation (65), notAllowedOnNonLeaf (66), notAllowedOnRDN (67), entryAlreadyExists (68), objectClassModsProhibited (69), -- 70 reserved for CLDAP -- affectsMultipleDSAs (71), -- 72-79 unused -- other (80), ... }, matchedDN LDAPDN, diagnosticMessage LDAPString, referral [3] Referral OPTIONAL }
Modifier and Type | Method and Description |
---|---|
String |
getDiagnosticMessage()
Gets the descriptive diagnostic message associated with the error code.
|
Dn |
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 |
isDefaultSuccess()
Tells if the LdapResult is a success, with no added information.
|
boolean |
isReferral()
Gets whether or not this result represents a Referral.
|
void |
setDiagnosticMessage(String diagnosticMessage)
Sets the descriptive diagnostic message associated with the error code.
|
void |
setMatchedDn(Dn 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.
|
ResultCodeEnum getResultCode()
void setResultCode(ResultCodeEnum resultCode)
resultCode
- the result code enum value.Dn getMatchedDn()
void setMatchedDn(Dn dn)
dn
- the Dn of the lowest matched entry.getMatchedDn()
String getDiagnosticMessage()
void setDiagnosticMessage(String diagnosticMessage)
diagnosticMessage
- the descriptive diagnostic message.boolean isReferral()
Referral getReferral()
void setReferral(Referral referral)
referral
- optional referral on REFERRAL errors.boolean isDefaultSuccess()
Copyright © 2003–2018 The Apache Software Foundation. All rights reserved.