Package org.ldaptive.auth
Class AuthenticationResponse
- java.lang.Object
-
- org.ldaptive.AbstractMessage
-
- org.ldaptive.AbstractResult
-
- org.ldaptive.auth.AuthenticationResponse
-
public class AuthenticationResponse extends AbstractResult
Synthetic response object that encapsulates data used for authentication.- Author:
- Middleware Services
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
AuthenticationResponse.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 inherited from interface org.ldaptive.Result
ENCODE_CNTRL_CHARS
-
-
Constructor Summary
Constructors Constructor Description AuthenticationResponse(AuthenticationHandlerResponse response, java.lang.String dn, LdapEntry entry)
Creates a new authentication response.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected static AuthenticationResponse.Builder
builder()
Creates a builder for this class.boolean
equals(java.lang.Object o)
AccountState
getAccountState()
Returns the account state associated with the authenticated user.AuthenticationHandlerResponse
getAuthenticationHandlerResponse()
AuthenticationResultCode
getAuthenticationResultCode()
LdapEntry
getLdapEntry()
Returns the ldap entry of the authenticated user.java.lang.String
getResolvedDn()
Returns the DN that was resolved in order to perform authentication.int
hashCode()
Returns the hash code for this object.boolean
isSuccess()
Returns whether the authentication handler produced aAuthenticationResultCode.AUTHENTICATION_HANDLER_SUCCESS
result.void
setAccountState(AccountState state)
Sets the account state for the authenticated user.java.lang.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
-
-
-
-
Constructor Detail
-
AuthenticationResponse
public AuthenticationResponse(AuthenticationHandlerResponse response, java.lang.String dn, LdapEntry entry)
Creates a new authentication response.- Parameters:
response
- authentication handler responsedn
- produced by the DN resolverentry
- of the authenticated user
-
-
Method Detail
-
isSuccess
public boolean isSuccess()
Returns whether the authentication handler produced aAuthenticationResultCode.AUTHENTICATION_HANDLER_SUCCESS
result.- Returns:
- whether authentication was successful
-
getAuthenticationResultCode
public AuthenticationResultCode getAuthenticationResultCode()
-
getAuthenticationHandlerResponse
public AuthenticationHandlerResponse getAuthenticationHandlerResponse()
-
getResolvedDn
public java.lang.String getResolvedDn()
Returns the DN that was resolved in order to perform authentication.- Returns:
- resolved dn
-
getLdapEntry
public LdapEntry getLdapEntry()
Returns the ldap entry of the authenticated user.- Returns:
- ldap entry
-
getAccountState
public AccountState getAccountState()
Returns the account state associated with the authenticated user.- Returns:
- account state
-
setAccountState
public void setAccountState(AccountState state)
Sets the account state for the authenticated user.- Parameters:
state
- for this user
-
equals
public boolean equals(java.lang.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 java.lang.String toString()
- Overrides:
toString
in classAbstractResult
-
builder
protected static AuthenticationResponse.Builder builder()
Creates a builder for this class.- Returns:
- new builder
-
-