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

Class SearchNoDResponse

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.SearchResultDoneImpl

org.apache.directory.api.ldap.model.message.extended.SearchNoDResponse

All Implemented Interfaces:

Message, Response, ResultResponse, SearchResultDone

public final class SearchNoDResponse
extends SearchResultDoneImpl

An extended operation intended for notifying clients of upcoming disconnection for the Search response.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID The OID of the NotiveOfDisconnect extended operation.
static SearchNoDResponse	PROTOCOLERROR The single instance with protocolError result code.
static SearchNoDResponse	STRONGAUTHREQUIRED The single instance with strongAuthRequired result code.
static SearchNoDResponse	UNAVAILABLE The single instance with unavailable result code.

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

Modifier	Constructor and Description
private	SearchNoDResponse(ResultCodeEnum rcode) Creates a new instance of NoticeOfDisconnect.

Method Summary

Modifier and Type	Method and Description
byte[]	getResponse() Gets the reponse 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.api.ldap.model.message.SearchResultDoneImpl

equals, hashCode, toString

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.ResultResponse

getLdapResult

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

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

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

The OID of the NotiveOfDisconnect extended operation.

See Also:

Constant Field Values

UNAVAILABLE

public static final SearchNoDResponse UNAVAILABLE

The single instance with unavailable result code.

PROTOCOLERROR

public static final SearchNoDResponse PROTOCOLERROR

The single instance with protocolError result code.

STRONGAUTHREQUIRED

public static final SearchNoDResponse STRONGAUTHREQUIRED

The single instance with strongAuthRequired result code.

Constructor Detail

SearchNoDResponse

private SearchNoDResponse(ResultCodeEnum rcode)

Creates a new instance of NoticeOfDisconnect.

Parameters:

rcode - The ResultCodeEnum value to wrap

Method Detail

getResponse

public byte[] getResponse()

Gets the reponse OID specific encoded response values.

Returns:

the response specific encoded response values.

getResponseName

public String getResponseName()

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

Returns:

the OID of the extended response type.