DeleteRequest (Ldaptive 2.3.2 API)

java.lang.Object
- org.ldaptive.AbstractRequestMessage
- - org.ldaptive.DeleteRequest

All Implemented Interfaces:: Request

public class DeleteRequest
extends AbstractRequestMessage

LDAP delete request defined as:

   DelRequest ::= [APPLICATION 10] LDAPDN

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DeleteRequest.Builder
Delete 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 String ldapDn
LDAP DN to delete.

static int PROTOCOL_OP
BER protocol number.
- Fields inherited from class org.ldaptive.AbstractRequestMessage
  logger

Constructor Summary

Constructors
Modifier Constructor Description

private DeleteRequest()
Default constructor.

DeleteRequest(String dn)
Creates a new delete request.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DeleteRequest.Builder`	`builder()`	Creates a builder for this class.
`String`	`getDn()`	Returns the DN.
`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 Detail
  - PROTOCOL_OP
```
public static final int PROTOCOL_OP
```
    BER protocol number.
    
    See Also:
    
    Constant Field Values
  - ldapDn
```
private String ldapDn
```
    LDAP DN to delete.
- Constructor Detail
  - DeleteRequest
```
private DeleteRequest()
```
    Default constructor.
  - DeleteRequest
```
public DeleteRequest(String dn)
```
    Creates a new delete request.
    
    Parameters:
    
    dn - DN to delete
- Method Detail
  - getDn
```
public String getDn()
```
    Returns the DN.
    
    Returns:
    
    DN
  - 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 DeleteRequest.Builder builder()
```
    Creates a builder for this class.
    
    Returns:
    
    new builder