Package org.apache.directory.api.ldap.model.message

Class AbstractExtendedResponse

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.AbstractResultResponse

org.apache.directory.api.ldap.model.message.AbstractExtendedResponse

All Implemented Interfaces:

ExtendedResponse, Message, Response, ResultResponse

Direct Known Subclasses:

CancelResponseImpl, CertGenerationResponseImpl, EndTransactionResponseImpl, ExtendedNoDResponse, GracefulDisconnectResponseImpl, GracefulShutdownResponseImpl, NoticeOfDisconnect, OpaqueExtendedResponse, PasswordModifyResponseImpl, StartTlsResponseImpl, StartTransactionResponseImpl, StoredProcedureResponseImpl, WhoAmIResponseImpl

public abstract class AbstractExtendedResponse
extends AbstractResultResponse
implements ExtendedResponse

An Abstract ExtendedResponse implementation.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field	Description
protected String	responseName	Object identifier for the extended response
(package private) static long	serialVersionUID

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

ldapResult

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Constructor Summary

Constructors

Constructor	Description
AbstractExtendedResponse(int id)	Creates an ExtendedResponse as a reply to an ExtendedRequest.
AbstractExtendedResponse(int id, String responseName)	Creates an ExtendedResponse as a reply to an ExtendedRequest.
AbstractExtendedResponse(String responseName)	Creates an ExtendedResponse as a reply to an ExtendedRequest.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	Checks to see if an object equals this ExtendedRequest.
String	getResponseName()	Gets the OID uniquely identifying this extended response (a.k.a.
int	hashCode()
void	setResponseName(String responseName)	Sets the OID uniquely identifying this extended response (a.k.a.
String	toString()	Get a String representation of an ExtendedResponse

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractResultResponse

getLdapResult

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponse

getLdapResult

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

responseName

protected String responseName

Object identifier for the extended response

Constructor Detail

AbstractExtendedResponse

public AbstractExtendedResponse(String responseName)

Creates an ExtendedResponse as a reply to an ExtendedRequest.

Parameters:

responseName - the ExtendedResponse's name

AbstractExtendedResponse

public AbstractExtendedResponse(int id,
                                String responseName)

Creates an ExtendedResponse as a reply to an ExtendedRequest.

Parameters:

id - the session unique message id

responseName - the ExtendedResponse's name

AbstractExtendedResponse

public AbstractExtendedResponse(int id)

Creates an ExtendedResponse as a reply to an ExtendedRequest.

Parameters:

id - the session unique message id

Method Detail

getResponseName

public String getResponseName()

Gets the OID uniquely identifying this extended response (a.k.a. its name).

Specified by:

getResponseName in interface ExtendedResponse

Returns:

the responseName of the extended response

setResponseName

public void setResponseName(String responseName)

Sets the OID uniquely identifying this extended response (a.k.a. its name).

Specified by:

setResponseName in interface ExtendedResponse

Parameters:

responseName - the OID of the extended response type.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResultResponse

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class AbstractResultResponse

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise

toString

public String toString()

Get a String representation of an ExtendedResponse

Overrides:

toString in class AbstractResultResponse

Returns:

An ExtendedResponse String