Package org.ldaptive
Class AbstractResult
java.lang.Object
org.ldaptive.AbstractMessage
org.ldaptive.AbstractResult
- Direct Known Subclasses:
AddResponse
,AuthenticationHandlerResponse
,AuthenticationResponse
,BindResponse
,CompareResponse
,DeleteResponse
,ExtendedResponse
,ModifyDnResponse
,ModifyResponse
,SearchResponse
LDAP result message defined as:
LDAPResult ::= SEQUENCE { resultCode ENUMERATED { ... }, matchedDN LDAPDN, diagnosticMessage LDAPString, referral [3] Referral OPTIONAL } Referral ::= SEQUENCE SIZE (1..MAX) OF uri URI URI ::= LDAPString -- limited to characters permitted in -- URIs
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
AbstractResult.AbstractBuilder<B,
T extends AbstractResult> protected static class
Parse handler implementation for the LDAP diagnostic message.protected static class
Parse handler implementation for the LDAP matched DN.protected static class
Parse handler implementation for the LDAP referral.protected static class
Parse handler implementation for the LDAP result code.Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage
AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Diagnostic message.private String
Matched DN.Referral URLS.private ResultCode
Result code.Fields inherited from interface org.ldaptive.Result
ENCODE_CNTRL_CHARS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addReferralURLs
(String... urls) Adds referral URLs to the result.protected <T extends Result>
voidcopyValues
(T result) Copies the property values from the supplied result to this result.boolean
Returns the diagnostic message.Returns the matched DN.String[]
Returns the referral URLs.Returns the result code.void
setDiagnosticMessage
(String message) void
setMatchedDN
(String dn) void
setResultCode
(ResultCode code) toString()
Methods inherited from class org.ldaptive.AbstractMessage
addControls, copyValues, getControls, getMessageID, hashCode, setMessageID
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.ldaptive.Message
getControl, getControls, getMessageID
Methods inherited from interface org.ldaptive.Result
getEncodedDiagnosticMessage, isSuccess
-
Field Details
-
resultCode
Result code. -
matchedDN
Matched DN. -
diagnosticMessage
Diagnostic message. -
referralURLs
Referral URLS.
-
-
Constructor Details
-
AbstractResult
public AbstractResult()
-
-
Method Details
-
getResultCode
Description copied from interface:Result
Returns the result code.- Specified by:
getResultCode
in interfaceResult
- Returns:
- result code
-
setResultCode
-
getMatchedDN
Description copied from interface:Result
Returns the matched DN.- Specified by:
getMatchedDN
in interfaceResult
- Returns:
- matched DN
-
setMatchedDN
-
getDiagnosticMessage
Description copied from interface:Result
Returns the diagnostic message.- Specified by:
getDiagnosticMessage
in interfaceResult
- Returns:
- diagnostic message
-
setDiagnosticMessage
-
getReferralURLs
Description copied from interface:Result
Returns the referral URLs.- Specified by:
getReferralURLs
in interfaceResult
- Returns:
- referral URLs
-
addReferralURLs
Adds referral URLs to the result.- Parameters:
urls
- to add
-
copyValues
Copies the property values from the supplied result to this result.- Type Parameters:
T
- type of result- Parameters:
result
- to copy from
-
equals
- Overrides:
equals
in classAbstractMessage
-
toString
- Overrides:
toString
in classAbstractMessage
-