org.apache.directory.shared.ldap.message.extended

Class CancelResponse

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractResponse

org.apache.directory.shared.ldap.message.internal.InternalAbstractResultResponse

org.apache.directory.shared.ldap.message.ExtendedResponseImpl

org.apache.directory.shared.ldap.message.extended.CancelResponse

All Implemented Interfaces:

Serializable, ExtendedResponse, InternalExtendedResponse, InternalMessage, InternalResponse, InternalResultResponse

public class CancelResponse
extends ExtendedResponseImpl

The response sent back from the server after the Cancel extended operation is performed.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.message.ExtendedResponseImpl

oid, value

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalExtendedResponse

TYPE

Constructor Summary

Constructors

Constructor and Description
CancelResponse(int messageId)
CancelResponse(int messageId, ResultCodeEnum rcode) Create a new CancelResponse object

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks to see if an object equals this ExtendedRequest.
byte[]	getResponse() Gets the response OID specific encoded response values.
String	getResponseName() Gets the OID uniquely identifying this extended response (a.k.a.

Methods inherited from class org.apache.directory.shared.ldap.message.ExtendedResponseImpl

getEncodedValue, getID, setOid, setResponse, setResponseName

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractResultResponse

getLdapResult, toString

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, hashCode, put, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalResultResponse

getLdapResult

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Constructor Detail

CancelResponse

public CancelResponse(int messageId,
                      ResultCodeEnum rcode)

Create a new CancelResponse object

Parameters:

messageId - The messageId

rcode - the result code

CancelResponse

public CancelResponse(int messageId)

Method Detail

getResponse

public byte[] getResponse()

Gets the response OID specific encoded response values. It's a null value for a CancelResponse

Specified by:

getResponse in interface InternalExtendedResponse

Overrides:

getResponse in class ExtendedResponseImpl

Returns:

the response specific encoded response values.

getResponseName

public String getResponseName()

Gets the OID uniquely identifying this extended response (a.k.a. its name). It's a null value for the Cancel response

Specified by:

getResponseName in interface InternalExtendedResponse

Overrides:

getResponseName in class ExtendedResponseImpl

Returns:

the OID of the extended response type.

equals

public boolean equals(Object obj)

Description copied from class: ExtendedResponseImpl

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class ExtendedResponseImpl

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise

See Also:

Object.equals(Object)