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

Class GracefulShutdownRequestImpl

java.lang.Object

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

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

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

org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequestImpl

All Implemented Interfaces:

GracefulShutdownRequest, ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class GracefulShutdownRequestImpl
extends AbstractExtendedRequest
implements GracefulShutdownRequest

An extended operation requesting the server to shutdown it's LDAP service port while allowing established clients to complete or abandon operations already in progress. More information about this extended request is available here: LDAP Extensions for Graceful Shutdown.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

EXTENSION_OID, NOW, UNDETERMINED

Constructor Summary

Constructors

Constructor and Description
GracefulShutdownRequestImpl() Instantiates a new graceful shutdown request.
GracefulShutdownRequestImpl(int messageId) Instantiates a new graceful shutdown request.
GracefulShutdownRequestImpl(int messageId, int timeOffline, int delay) Instantiates a new graceful shutdown request.

Method Summary

Modifier and Type	Method and Description
int	getDelay() Gets the delay before disconnection, in seconds.
GracefulShutdownResponse	getResultResponse() The result containing response for this request.
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 class org.apache.directory.api.ldap.model.message.AbstractExtendedRequest

addAllControls, addControl, equals, getRequestName, getResponse, getResponseType, hashCode, removeControl, setMessageId, setRequestName, setResponse, toString

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest

hasResponse

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

get, getControl, getControls, getMessageId, getType, hasControl, put, 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.ExtendedRequest

addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName

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

getResponseType

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

hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put

Constructor Detail

GracefulShutdownRequestImpl

public GracefulShutdownRequestImpl(int messageId)

Instantiates a new graceful shutdown request.

Parameters:

messageId - the message id

GracefulShutdownRequestImpl

public GracefulShutdownRequestImpl()

Instantiates a new graceful shutdown request.

Parameters:

messageId - the message id

GracefulShutdownRequestImpl

public GracefulShutdownRequestImpl(int messageId,
                                   int timeOffline,
                                   int delay)

Instantiates a new graceful shutdown request.

Parameters:

messageId - the message id

timeOffline - the offline time after disconnection, in minutes

delay - the delay before disconnection, in seconds

Method Detail

getDelay

public int getDelay()

Gets the delay before disconnection, in seconds.

Specified by:

getDelay in interface GracefulShutdownRequest

Returns:

the delay before disconnection

setDelay

public void setDelay(int delay)

Sets the delay before disconnection, in seconds.

Specified by:

setDelay in interface GracefulShutdownRequest

Parameters:

delay - the new delay before disconnection

getTimeOffline

public int getTimeOffline()

Gets the offline time after disconnection, in minutes.

Specified by:

getTimeOffline in interface GracefulShutdownRequest

Returns:

the offline time after disconnection

setTimeOffline

public void setTimeOffline(int timeOffline)

Sets the time offline after disconnection, in minutes.

Specified by:

setTimeOffline in interface GracefulShutdownRequest

Parameters:

timeOffline - the new time offline after disconnection

getResultResponse

public GracefulShutdownResponse getResultResponse()

Description copied from class: AbstractExtendedRequest

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest

Specified by:

getResultResponse in class AbstractExtendedRequest

Returns:

the result containing response for this request