org.apache.directory.api.ldap.extras.extended.gracefulDisconnect

Interface GracefulDisconnectResponse

All Superinterfaces:

org.apache.directory.api.ldap.model.message.ExtendedResponse, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Response, org.apache.directory.api.ldap.model.message.ResultResponse

All Known Implementing Classes:

GracefulDisconnectResponseImpl

public interface GracefulDisconnectResponse
extends org.apache.directory.api.ldap.model.message.ExtendedResponse

An unsolicited notification, extended response, intended for notifying clients of upcoming disconnection due to intended service windows. Unlike the org.apache.directory.api.ldap.model.message.extended.NoticeOfDisconnect this response contains additional information about the amount of time the server will be offline and exactly when it intends to shutdown.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID The OID for the graceful disconnect extended operation response.

Fields inherited from interface org.apache.directory.api.ldap.model.message.ExtendedResponse

TYPE

Method Summary

Methods

Modifier and Type	Method and Description
void	addReplicatedContexts(String replicatedContext) Add a new URL of a replicated server
int	getDelay() Gets the delay before disconnection, in seconds.
org.apache.directory.api.ldap.model.message.Referral	getReplicatedContexts() Gets the replicated contexts.
int	getTimeOffline() Gets the offline time after disconnection, in minutes.
void	setDelay(int delay) Sets the delay before disconnection, in seconds.
void	setTimeOffline(int timeOffline) Sets the time offline after disconnection, in minutes.

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

getResponseName, setResponseName

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

static final String EXTENSION_OID

The OID for the graceful disconnect extended operation response.

See Also:

Constant Field Values

Method Detail

getDelay

int getDelay()

Gets the delay before disconnection, in seconds.

Returns:

the delay before disconnection

setDelay

void setDelay(int delay)

Sets the delay before disconnection, in seconds.

Parameters:

delay - the new delay before disconnection

getTimeOffline

int getTimeOffline()

Gets the offline time after disconnection, in minutes.

Returns:

the offline time after disconnection

setTimeOffline

void setTimeOffline(int timeOffline)

Sets the time offline after disconnection, in minutes.

Parameters:

timeOffline - the new time offline after disconnection

getReplicatedContexts

org.apache.directory.api.ldap.model.message.Referral getReplicatedContexts()

Gets the replicated contexts.

Returns:

the replicated contexts

addReplicatedContexts

void addReplicatedContexts(String replicatedContext)

Add a new URL of a replicated server

Parameters:

replicatedContext - The replicated server to add.