org.ldaptive.extended

Class CancelRequest

java.lang.Object

org.ldaptive.AbstractRequest

org.ldaptive.extended.CancelRequest

All Implemented Interfaces:

ExtendedRequest, Message<RequestControl>, Request

public class CancelRequest
extends AbstractRequest
implements ExtendedRequest

Contains the data required to perform an ldap cancel operation. See RFC 3909.

Field Summary

Fields

Modifier and Type	Field and Description
private int	messageId message id to cancel.
static java.lang.String	OID OID of this extended request.

Constructor Summary

Constructors

Constructor and Description
CancelRequest() Default constructor.
CancelRequest(int id) Creates a new cancel request.

Method Summary

Modifier and Type	Method and Description
byte[]	encode() Provides the BER encoding of this request.
int	getMessageId() Returns the message id to cancel.
java.lang.String	getOID() Returns the OID for this extended request.
void	setMessageId(int id) Sets the message id to cancel.
java.lang.String	toString()

Methods inherited from class org.ldaptive.AbstractRequest

getControls, getIntermediateResponseHandlers, getReferralHandler, setControls, setIntermediateResponseHandlers, setReferralHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ldaptive.Request

getIntermediateResponseHandlers, getReferralHandler

Methods inherited from interface org.ldaptive.Message

getControls

Field Detail

OID

public static final java.lang.String OID

OID of this extended request.

See Also:

Constant Field Values

messageId

private int messageId

message id to cancel.

Constructor Detail

CancelRequest

public CancelRequest()

Default constructor.

CancelRequest

public CancelRequest(int id)

Creates a new cancel request.

Parameters:

id - of the message to cancel

Method Detail

getMessageId

public int getMessageId()

Returns the message id to cancel.

Returns:

message id

setMessageId

public void setMessageId(int id)

Sets the message id to cancel.

Parameters:

id - of the message to cancel

encode

public byte[] encode()

Description copied from interface: ExtendedRequest

Provides the BER encoding of this request.

Specified by:

encode in interface ExtendedRequest

Returns:

BER encoded request

getOID

public java.lang.String getOID()

Description copied from interface: ExtendedRequest

Returns the OID for this extended request.

Specified by:

getOID in interface ExtendedRequest

Returns:

oid

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object