org.apache.directory.shared.ldap.message.extended

Class GracefulShutdownRequest

java.lang.Object

org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

org.apache.directory.shared.ldap.message.ExtendedRequestImpl

org.apache.directory.shared.ldap.message.extended.GracefulShutdownRequest

All Implemented Interfaces:

Serializable, ExtendedRequest, InternalExtendedRequest, InternalMessage, InternalRequest, InternalResultResponseRequest, SingleReplyRequest

public class GracefulShutdownRequest
extends ExtendedRequestImpl

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.

Version:

$Rev: 912436 $

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTENSION_OID
static int	NOW The shutdown is immediate
static int	UNDETERMINED Undetermined value used for timeOffline

Fields inherited from class org.apache.directory.shared.ldap.message.ExtendedRequestImpl

payload, response

Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalExtendedRequest

RESP_TYPE, TYPE

Constructor Summary

Constructors

Constructor and Description
GracefulShutdownRequest(int messageId)
GracefulShutdownRequest(int messageId, int timeOffline, int delay)

Method Summary

Modifier and Type	Method and Description
ExtendedResponse	createExtendedResponse(String id, byte[] berValue, int offset, int length)
int	getDelay()
byte[]	getEncodedValue()
byte[]	getPayload() Gets the extended request's requestValue portion of the PDU.
InternalResultResponse	getResultResponse() The result containing response for this request.
int	getTimeOffline()
void	setDelay(int delay)
void	setPayload(byte[] payload) Sets the extended request's requestValue portion of the PDU.
void	setTimeOffline(int timeOffline)

Methods inherited from class org.apache.directory.shared.ldap.message.ExtendedRequestImpl

equals, getID, getOid, getResponseType, setOid, toString

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractRequest

hashCode, hasResponse

Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalRequest

hasResponse

Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage

add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

See Also:

Constant Field Values

UNDETERMINED

public static final int UNDETERMINED

Undetermined value used for timeOffline

See Also:

Constant Field Values

NOW

public static final int NOW

The shutdown is immediate

See Also:

Constant Field Values

Constructor Detail

GracefulShutdownRequest

public GracefulShutdownRequest(int messageId)

GracefulShutdownRequest

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

Method Detail

setPayload

public void setPayload(byte[] payload)

Description copied from class: ExtendedRequestImpl

Sets the extended request's requestValue portion of the PDU.

Specified by:

setPayload in interface InternalExtendedRequest

Overrides:

setPayload in class ExtendedRequestImpl

Parameters:

payload - byte array of data encapsulating ext. req. parameters

createExtendedResponse

public ExtendedResponse createExtendedResponse(String id,
                                               byte[] berValue,
                                               int offset,
                                               int length)
                                        throws NamingException

Specified by:

createExtendedResponse in interface ExtendedRequest

Overrides:

createExtendedResponse in class ExtendedRequestImpl

Throws:

NamingException

getEncodedValue

public byte[] getEncodedValue()

Specified by:

getEncodedValue in interface ExtendedRequest

Overrides:

getEncodedValue in class ExtendedRequestImpl

getPayload

public byte[] getPayload()

Description copied from class: ExtendedRequestImpl

Gets the extended request's requestValue portion of the PDU. The form of the data is request specific and is determined by the extended request OID.

Specified by:

getPayload in interface InternalExtendedRequest

Overrides:

getPayload in class ExtendedRequestImpl

Returns:

byte array of data

getResultResponse

public InternalResultResponse getResultResponse()

Description copied from class: ExtendedRequestImpl

The result containing response for this request.

Specified by:

getResultResponse in interface InternalResultResponseRequest

Overrides:

getResultResponse in class ExtendedRequestImpl

Returns:

the result containing response for this request

getDelay

public int getDelay()

setDelay

public void setDelay(int delay)

getTimeOffline

public int getTimeOffline()

setTimeOffline

public void setTimeOffline(int timeOffline)