Package org.ldaptive.auth

Class AuthenticationHandlerResponse

java.lang.Object

org.ldaptive.AbstractMessage

org.ldaptive.AbstractResult

org.ldaptive.auth.AuthenticationHandlerResponse

All Implemented Interfaces:

Message, Result

public final class AuthenticationHandlerResponse
extends AbstractResult

Response object for authentication handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final 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 final int	HASH_CODE_SEED	hash code seed.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AuthenticationHandlerResponse()	Default constructor.
	AuthenticationHandlerResponse(T result, AuthenticationResultCode code, Connection conn)	Creates a new authentication response.

Method Summary

Modifier and Type	Method	Description
(package private) static AuthenticationHandlerResponse.Builder	builder()	Creates a builder for this class.
boolean	equals(Object o)
AuthenticationResultCode	getAuthenticationResultCode()	Returns the authentication result code.
Connection	getConnection()	Returns the connection that authentication occurred on.
int	hashCode()	Returns the hash code for this object.
boolean	isSuccess()	Returns whether the result code in this result is ResultCode.SUCCESS.
String	toString()

Methods inherited from class org.ldaptive.AbstractResult

addReferralURLs, copyValues, equalsResult, getDiagnosticMessage, getMatchedDN, getReferralURLs, getResultCode, setDiagnosticMessage, setMatchedDN, setResultCode

Methods inherited from class org.ldaptive.AbstractMessage

addControls, copyValues, equalsMessage, 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

Field Details

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 Details

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 response

code - authentication result code

conn - connection the authentication occurred on

Method Details

getAuthenticationResultCode

public AuthenticationResultCode getAuthenticationResultCode()

Returns the authentication result code.

Returns:

authentication result code

getConnection

public Connection getConnection()

Returns the connection that authentication occurred on.

Returns:

connection

isSuccess

public boolean isSuccess()

Description copied from interface: Result

Returns whether the result code in this result is ResultCode.SUCCESS.

Returns:

whether this result is success

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractResult

hashCode

public int hashCode()

Description copied from class: AbstractMessage

Returns the hash code for this object.

Specified by:

hashCode in class AbstractMessage

Returns:

hash code

toString

public String toString()

Overrides:

toString in class AbstractResult

builder

static AuthenticationHandlerResponse.Builder builder()

Creates a builder for this class.

Returns:

new builder