org.ldaptive.auth

Class AuthenticationHandlerResponse

java.lang.Object

org.ldaptive.Response<Boolean>

org.ldaptive.auth.AuthenticationHandlerResponse

All Implemented Interfaces:

Message<ResponseControl>, ResponseMessage

public class AuthenticationHandlerResponse
extends Response<Boolean>

Response object for authentication handlers.

Field Summary

Fields

Modifier and Type	Field and Description
private Connection	connection Connection that authentication occurred on.

Fields inherited from class org.ldaptive.Response

ENCODE_CNTRL_CHARS, encodeCntrlChars

Constructor Summary

Constructors

Constructor and Description
AuthenticationHandlerResponse(boolean success, ResultCode rc, Connection conn) Creates a new authentication response.
AuthenticationHandlerResponse(boolean success, ResultCode rc, Connection conn, String msg) Creates a new authentication response.
AuthenticationHandlerResponse(boolean success, ResultCode rc, Connection conn, String msg, ResponseControl[] controls, int msgId) Creates a new ldap response.

Method Summary

Modifier and Type	Method and Description
Connection	getConnection() Returns the connection that the ldap operation occurred on.
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

connection

private final Connection connection

Connection that authentication occurred on.

Constructor Detail

AuthenticationHandlerResponse

public AuthenticationHandlerResponse(boolean success,
                                     ResultCode rc,
                                     Connection conn)

Creates a new authentication response.

Parameters:

success - authentication result

rc - result code from the underlying ldap operation

conn - connection the authentication occurred on

AuthenticationHandlerResponse

public AuthenticationHandlerResponse(boolean success,
                                     ResultCode rc,
                                     Connection conn,
                                     String msg)

Creates a new authentication response.

Parameters:

success - authentication result

rc - result code from the underlying ldap operation

conn - connection the authentication occurred on

msg - authentication message

AuthenticationHandlerResponse

public AuthenticationHandlerResponse(boolean success,
                                     ResultCode rc,
                                     Connection conn,
                                     String msg,
                                     ResponseControl[] controls,
                                     int msgId)

Creates a new ldap response.

Parameters:

success - authentication result

rc - result code from the underlying ldap operation

conn - connection the authentication occurred on

msg - authentication message

controls - response controls from the underlying ldap operation

msgId - message id from the underlying ldap operation

Method Detail

getConnection

public Connection getConnection()

Returns the connection that the ldap operation occurred on.

Returns:

connection

toString

public String toString()

Overrides:

toString in class Response<Boolean>