Package org.ldaptive

Class AbstractResult

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.AbstractResult

All Implemented Interfaces:

Message, Result

Direct Known Subclasses:

AddResponse, AuthenticationHandlerResponse, AuthenticationResponse, BindResponse, CompareResponse, DeleteResponse, ExtendedResponse, ModifyDnResponse, ModifyResponse, SearchResponse

public abstract class AbstractResult
extends AbstractMessage
implements Result

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
 

Author:

Middleware Services

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AbstractResult.AbstractBuilder<B,T extends AbstractResult>
protected static class	AbstractResult.DiagnosticMessageHandler	Parse handler implementation for the LDAP diagnostic message.
protected static class	AbstractResult.MatchedDNHandler	Parse handler implementation for the LDAP matched DN.
protected static class	AbstractResult.ReferralHandler	Parse handler implementation for the LDAP referral.
protected static class	AbstractResult.ResultCodeHandler	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

Fields inherited from interface org.ldaptive.Result

ENCODE_CNTRL_CHARS

Constructor Summary

Constructors

Constructor	Description
AbstractResult()

Method Summary

Modifier and Type	Method	Description
void	addReferralURLs(java.lang.String... urls)	Adds referral URLs to the result.
protected <T extends Result> void	copyValues(T result)	Copies the property values from the supplied result to this result.
boolean	equals(java.lang.Object o)
java.lang.String	getDiagnosticMessage()	Returns the diagnostic message.
java.lang.String	getMatchedDN()	Returns the matched DN.
java.lang.String[]	getReferralURLs()	Returns the referral URLs.
ResultCode	getResultCode()	Returns the result code.
void	setDiagnosticMessage(java.lang.String message)
void	setMatchedDN(java.lang.String dn)
void	setResultCode(ResultCode code)
java.lang.String	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

Constructor Detail

AbstractResult

public AbstractResult()

Method Detail

getResultCode

public ResultCode getResultCode()

Description copied from interface: Result

Returns the result code.

Specified by:

getResultCode in interface Result

Returns:

result code

setResultCode

public void setResultCode(ResultCode code)

getMatchedDN

public java.lang.String getMatchedDN()

Description copied from interface: Result

Returns the matched DN.

Specified by:

getMatchedDN in interface Result

Returns:

matched DN

setMatchedDN

public void setMatchedDN(java.lang.String dn)

getDiagnosticMessage

public java.lang.String getDiagnosticMessage()

Description copied from interface: Result

Returns the diagnostic message.

Specified by:

getDiagnosticMessage in interface Result

Returns:

diagnostic message

setDiagnosticMessage

public void setDiagnosticMessage(java.lang.String message)

getReferralURLs

public java.lang.String[] getReferralURLs()

Description copied from interface: Result

Returns the referral URLs.

Specified by:

getReferralURLs in interface Result

Returns:

referral URLs

addReferralURLs

public void addReferralURLs(java.lang.String... urls)

Adds referral URLs to the result.

Parameters:

urls - to add

copyValues

protected <T extends Result> void copyValues(T result)

Copies the property values from the supplied result to this result.

Type Parameters:

T - type of result

Parameters:

result - to copy from

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class AbstractMessage

toString

public java.lang.String toString()

Overrides:

toString in class AbstractMessage