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 interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest
EXTENSION_OID, NOW, UNDETERMINED
-
-
Constructor Summary
Constructors Constructor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 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.SingleReplyRequest
getResponseType
-
-
-
-
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.
-
GracefulShutdownRequestImpl
public GracefulShutdownRequestImpl(int messageId, int timeOffline, int delay)
Instantiates a new graceful shutdown request.- Parameters:
messageId
- the message idtimeOffline
- the offline time after disconnection, in minutesdelay
- the delay before disconnection, in seconds
-
-
Method Detail
-
getDelay
public int getDelay()
Gets the delay before disconnection, in seconds.- Specified by:
getDelay
in interfaceGracefulShutdownRequest
- Returns:
- the delay before disconnection
-
setDelay
public void setDelay(int delay)
Sets the delay before disconnection, in seconds.- Specified by:
setDelay
in interfaceGracefulShutdownRequest
- Parameters:
delay
- the new delay before disconnection
-
getTimeOffline
public int getTimeOffline()
Gets the offline time after disconnection, in minutes.- Specified by:
getTimeOffline
in interfaceGracefulShutdownRequest
- Returns:
- the offline time after disconnection
-
setTimeOffline
public void setTimeOffline(int timeOffline)
Sets the time offline after disconnection, in minutes.- Specified by:
setTimeOffline
in interfaceGracefulShutdownRequest
- Parameters:
timeOffline
- the new time offline after disconnection
-
getResultResponse
public GracefulShutdownResponse getResultResponse()
The result containing response for this request.- Specified by:
getResultResponse
in interfaceResultResponseRequest
- Specified by:
getResultResponse
in classAbstractExtendedRequest
- Returns:
- the result containing response for this request
-
-