GracefulShutdownRequest (Apache LDAP API 2.1.1 API Documentation)

All Superinterfaces:

ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

All Known Implementing Classes:

GracefulShutdownRequestImpl
```
public interface GracefulShutdownRequest
extends ExtendedRequest
```
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
Modifier and Type	Field	Description
`static String`	`EXTENSION_OID`	The OID for the graceful shutdown extended operation request.
`static int`	`NOW`	The shutdown is immediate
`static int`	`UNDETERMINED`	Undetermined value used for offline time

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`getDelay()`	Gets the delay before disconnection, in seconds.
`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.ExtendedRequest
addAllControls, addControl, getRequestName, removeControl, setMessageId, setRequestName

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, getType, hasControl, put

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

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

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

- Field Detail
  - EXTENSION_OID
```
static final String EXTENSION_OID
```
    The OID for the graceful shutdown extended operation request.
    
    See Also:
    
    Constant Field Values
  - UNDETERMINED
```
static final int UNDETERMINED
```
    Undetermined value used for offline time
    
    See Also:
    
    Constant Field Values
  - NOW
```
static final int NOW
```
    The shutdown is immediate
    
    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