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.

Field Summary

Fields

Modifier and Type	Field and Description
private AccountState	accountState Account state.
private AuthenticationResultCode	authenticationResultCode Result of the authentication operation.
private LdapEntry	ldapEntry Ldap entry of authenticated user.
private String	resolvedDn Resolved DN.

Fields inherited from class org.ldaptive.Response

ENCODE_CNTRL_CHARS, encodeCntrlChars

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
String	getResolvedDn() Returns the DN that was resolved in order to perform authentication.
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

Field Detail

authenticationResultCode

private final AuthenticationResultCode authenticationResultCode

Result of the authentication operation.

resolvedDn

private final String resolvedDn

Resolved DN.

ldapEntry

private final LdapEntry ldapEntry

Ldap entry of authenticated user.

accountState

private AccountState accountState

Account state.

Constructor Detail

AuthenticationResponse

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

Creates a new authentication response.

Parameters:

authRc - authentication result code

rc - result code from the underlying ldap operation

dn - produced by the DN resolver

entry - of the authenticated user

AuthenticationResponse

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

Creates a new authentication response.

Parameters:

authRc - authentication result code

rc - result code from the underlying ldap operation

dn - produced by the DN resolver

entry - of the authenticated user

msg - authentication message

AuthenticationResponse

public AuthenticationResponse(AuthenticationResultCode authRc,
                              ResultCode rc,
                              String dn,
                              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

dn - produced by the DN resolver

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

getResolvedDn

public 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

toString

public String toString()

Overrides:

toString in class Response<Boolean>