org.ldaptive.auth
Class AuthenticationResponse

java.lang.Object
  org.ldaptive.Response<Boolean>
      org.ldaptive.auth.AuthenticationResponse

All Implemented Interfaces:

Message<ResponseControl>, ResponseMessage

public class AuthenticationResponse
extends Response<Boolean>

Response object for authenticator.

Version:

$Revision: 3266 $ $Date: 2018-09-12 14:42:07 -0400 (Wed, 12 Sep 2018) $

Author:

Middleware Services

Field Summary

Fields inherited from class org.ldaptive.Response

ENCODE_CNTRL_CHARS, encodeCntrlChars

Constructor Summary

AuthenticationResponse(AuthenticationResultCode authRc, ResultCode rc, LdapEntry entry)
Creates a new authentication response.

AuthenticationResponse(AuthenticationResultCode authRc, ResultCode rc, LdapEntry entry, String msg)
Creates a new authentication response.

AuthenticationResponse(AuthenticationResultCode authRc, ResultCode rc, LdapEntry entry, String msg, ResponseControl[] controls, int msgId)
Creates a new authentication response.

Method Summary

AccountState	getAccountState() Returns the account state associated with the authenticated user.
AuthenticationResultCode	getAuthenticationResultCode() Returns the result code associated with the authentication operation.
LdapEntry	getLdapEntry() Returns the ldap entry of the authenticated user.
void	setAccountState(AccountState state) Sets the account state for the authenticated user.
String	toString()

Methods inherited from class org.ldaptive.Response

getControl, getControls, getMatchedDn, getMessage, getMessageId, getReferralURLs, getResult, getResultCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationResponse

public AuthenticationResponse(AuthenticationResultCode authRc,
                              ResultCode rc,
                              LdapEntry entry)

Creates a new authentication response.

Parameters:

authRc - authentication result code

rc - result code from the underlying ldap operation

entry - of the authenticated user

AuthenticationResponse

public AuthenticationResponse(AuthenticationResultCode authRc,
                              ResultCode rc,
                              LdapEntry entry,
                              String msg)

Creates a new authentication response.

Parameters:

authRc - authentication result code

rc - result code from the underlying ldap operation

entry - of the authenticated user

msg - authentication message

AuthenticationResponse

public AuthenticationResponse(AuthenticationResultCode authRc,
                              ResultCode rc,
                              LdapEntry entry,
                              String msg,
                              ResponseControl[] controls,
                              int msgId)

Creates a new authentication response.

Parameters:

authRc - authentication result code

rc - result code from the underlying ldap operation

entry - of the authenticated user

msg - authentication message

controls - response controls from the underlying ldap operation

msgId - message id from the underlying ldap operation

Method Detail

getAuthenticationResultCode

public AuthenticationResultCode getAuthenticationResultCode()

Returns the result code associated with the authentication operation.

Returns:

authentication result code

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

toString

public String toString()

Overrides:

toString in class Response<Boolean>