Package org.ldaptive

Class AbandonRequest

java.lang.Object

org.ldaptive.AbstractRequestMessage

org.ldaptive.AbandonRequest

All Implemented Interfaces:

Request

public class AbandonRequest
extends AbstractRequestMessage

LDAP abandon request defined as:

   AbandonRequest ::= [APPLICATION 16] MessageID
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbandonRequest.Builder	Abandon request builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractRequestMessage

AbstractRequestMessage.AbstractBuilder<B,T extends AbstractRequestMessage>

Field Summary

Fields

Modifier and Type	Field	Description
private int	messageID	Protocol message ID.
static final int	PROTOCOL_OP	Protocol operation identifier.

Fields inherited from class org.ldaptive.AbstractRequestMessage

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AbandonRequest()	Default constructor.
	AbandonRequest(int id)	Creates a new abandon request.

Method Summary

Modifier and Type	Method	Description
static AbandonRequest.Builder	builder()	Creates a builder for this class.
int	getMessageID()	Returns the message ID.
protected DEREncoder[]	getRequestEncoders(int id)	Returns the request encoders for this message.
String	toString()

Methods inherited from class org.ldaptive.AbstractRequestMessage

encode, getControls, getResponseTimeout, setControls, setResponseTimeout

Methods inherited from class java.lang.Object

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

Field Details

PROTOCOL_OP

public static final int PROTOCOL_OP

Protocol operation identifier.

See Also:

• Constant Field Values

messageID

private int messageID

Protocol message ID.

Constructor Details

AbandonRequest

private AbandonRequest()

Default constructor.

AbandonRequest

public AbandonRequest(int id)

Creates a new abandon request.

Parameters:

id - message ID

Method Details

getMessageID

public int getMessageID()

Returns the message ID.

Returns:

message ID

getRequestEncoders

protected DEREncoder[] getRequestEncoders(int id)

Description copied from class: AbstractRequestMessage

Returns the request encoders for this message.

Specified by:

getRequestEncoders in class AbstractRequestMessage

Parameters:

id - message ID

Returns:

request encoders

toString

public String toString()

Overrides:

toString in class AbstractRequestMessage

builder

public static AbandonRequest.Builder builder()

Creates a builder for this class.

Returns:

new builder