Package org.ldaptive.auth
Class AuthenticationHandlerResponse
- java.lang.Object
-
- org.ldaptive.AbstractMessage
-
- org.ldaptive.AbstractResult
-
- org.ldaptive.auth.AuthenticationHandlerResponse
-
public class AuthenticationHandlerResponse extends AbstractResult
Response object for authentication handlers.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AuthenticationHandlerResponse.Builder
-
Nested classes/interfaces inherited from class org.ldaptive.AbstractResult
AbstractResult.AbstractBuilder<B,T extends AbstractResult>, AbstractResult.DiagnosticMessageHandler, AbstractResult.MatchedDNHandler, AbstractResult.ReferralHandler, AbstractResult.ResultCodeHandler
-
Nested classes/interfaces inherited from class org.ldaptive.AbstractMessage
AbstractMessage.ControlParser, AbstractMessage.ControlsHandler, AbstractMessage.MessageIDHandler
-
-
Field Summary
Fields Modifier and Type Field Description private AuthenticationResultCode
authenticationResultCode
Authentication result code.private Connection
connection
Connection that authentication occurred on.private static int
HASH_CODE_SEED
hash code seed.-
Fields inherited from interface org.ldaptive.Result
ENCODE_CNTRL_CHARS
-
-
Constructor Summary
Constructors Modifier Constructor Description private
AuthenticationHandlerResponse()
Default constructor.AuthenticationHandlerResponse(T result, AuthenticationResultCode code, Connection conn)
Creates a new authentication response.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static AuthenticationHandlerResponse.Builder
builder()
Creates a builder for this class.boolean
equals(Object o)
AuthenticationResultCode
getAuthenticationResultCode()
Connection
getConnection()
int
hashCode()
Returns the hash code for this object.String
toString()
-
Methods inherited from class org.ldaptive.AbstractResult
addReferralURLs, copyValues, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode
-
Methods inherited from class org.ldaptive.AbstractMessage
addControls, copyValues, getControls, getMessageID, 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 Detail
-
HASH_CODE_SEED
private static final int HASH_CODE_SEED
hash code seed.- See Also:
- Constant Field Values
-
authenticationResultCode
private AuthenticationResultCode authenticationResultCode
Authentication result code.
-
connection
private Connection connection
Connection that authentication occurred on.
-
-
Constructor Detail
-
AuthenticationHandlerResponse
private AuthenticationHandlerResponse()
Default constructor.
-
AuthenticationHandlerResponse
public AuthenticationHandlerResponse(T result, AuthenticationResultCode code, Connection conn)
Creates a new authentication response.- Type Parameters:
T
- type of LDAP result- Parameters:
result
- of the LDAP operation used to produce this responsecode
- authentication result codeconn
- connection the authentication occurred on
-
-
Method Detail
-
getAuthenticationResultCode
public AuthenticationResultCode getAuthenticationResultCode()
-
getConnection
public Connection getConnection()
-
equals
public boolean equals(Object o)
- Overrides:
equals
in classAbstractResult
-
hashCode
public int hashCode()
Description copied from class:AbstractMessage
Returns the hash code for this object.- Specified by:
hashCode
in classAbstractMessage
- Returns:
- hash code
-
toString
public String toString()
- Overrides:
toString
in classAbstractResult
-
builder
protected static AuthenticationHandlerResponse.Builder builder()
Creates a builder for this class.- Returns:
- new builder
-
-