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

java.lang.Object
  extended byorg.apache.directory.shared.ldap.message.AbstractMessage
      extended byorg.apache.directory.shared.ldap.message.AbstractRequest
          extended byorg.apache.directory.shared.ldap.message.ExtendedRequestImpl
              extended byorg.apache.directory.shared.ldap.message.extended.GracefulShutdownRequest
All Implemented Interfaces:
javax.naming.ldap.ExtendedRequest, ExtendedRequest, Message, Request, ResultResponseRequest, java.io.Serializable, 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: 379008 $
Author:
Apache Directory Project
See Also:
Serialized Form

Field Summary
static java.lang.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.ExtendedRequest
RESP_TYPE, TYPE
 
Constructor Summary
GracefulShutdownRequest(int messageId)
           
GracefulShutdownRequest(int messageId, int timeOffline, int delay)
           
 
Method Summary
 javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id, byte[] berValue, int offset, int length)
           
 int getDelay()
           
 byte[] getEncodedValue()
           
 byte[] getPayload()
          Gets the extended request's requestValue portion of the PDU.
 ResultResponse 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.AbstractRequest
hasResponse
 
Methods inherited from class org.apache.directory.shared.ldap.message.AbstractMessage
add, get, getControls, getMessageId, getType, put, remove
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Request
hasResponse
 
Methods inherited from interface org.apache.directory.shared.ldap.message.Message
add, get, getControls, getMessageId, getType, put, remove
 

Field Detail

EXTENSION_OID

public static final java.lang.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 ExtendedRequest
Overrides:
setPayload in class ExtendedRequestImpl
Parameters:
payload - byte array of data encapsulating ext. req. parameters

createExtendedResponse

public javax.naming.ldap.ExtendedResponse createExtendedResponse(java.lang.String id,
                                                                 byte[] berValue,
                                                                 int offset,
                                                                 int length)
                                                          throws javax.naming.NamingException
Specified by:
createExtendedResponse in interface javax.naming.ldap.ExtendedRequest
Overrides:
createExtendedResponse in class ExtendedRequestImpl
Throws:
javax.naming.NamingException

getEncodedValue

public byte[] getEncodedValue()
Specified by:
getEncodedValue in interface javax.naming.ldap.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 ExtendedRequest
Overrides:
getPayload in class ExtendedRequestImpl
Returns:
byte array of data

getResultResponse

public ResultResponse getResultResponse()
Description copied from class: ExtendedRequestImpl
The result containing response for this request.

Specified by:
getResultResponse in interface ResultResponseRequest
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)


Copyright © 2003-2006 . All Rights Reserved.