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

Class GracefulShutdownRequestDecorator

java.lang.Object

org.apache.directory.api.ldap.codec.api.MessageDecorator<M>

org.apache.directory.api.ldap.codec.decorators.RequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator<M>

org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator<Q>

org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator<GracefulShutdownRequest>

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

All Implemented Interfaces:

Asn1Object, Decorator<GracefulShutdownRequest>, GracefulShutdownRequest, AbandonableRequest, ExtendedRequest, Message, Request, ResultResponseRequest, SingleReplyRequest

public class GracefulShutdownRequestDecorator
extends ExtendedRequestDecorator<GracefulShutdownRequest>
implements GracefulShutdownRequest

A Decorator for GracefulShutdownRequests.

Field Summary

Fields

Modifier and Type	Field and Description
private int	gracefulSequenceLength Length of the sequence
private GracefulShutdownRequest	gracefulShutdownRequest
private static org.slf4j.Logger	LOG

Fields inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

requestValue

Fields inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

messageLength

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

EXTENSION_OID, NOW, UNDETERMINED

Constructor Summary

Constructors

Constructor and Description
GracefulShutdownRequestDecorator(LdapApiService codec, GracefulShutdownRequest decoratedMessage) Creates a new instance of GracefulShutdownRequestDecorator.

Method Summary

Modifier and Type	Method and Description
(package private) int	computeLengthInternal() Compute the GracefulShutdown length
(package private) java.nio.ByteBuffer	encodeInternal() Encodes the gracefulShutdown extended operation.
int	getDelay() Gets the delay before disconnection, in seconds.
byte[]	getRequestValue()
int	getTimeOffline() Gets the offline time after disconnection, in minutes.
void	setDelay(int delay) Sets the delay before disconnection, in seconds.
void	setRequestValue(byte[] requestValue)
void	setTimeOffline(int timeOffline) Sets the time offline after disconnection, in minutes.
java.lang.String	toString() Return a string representation of the graceful shutdown

Methods inherited from class org.apache.directory.api.ldap.codec.api.ExtendedRequestDecorator

addAllControls, addControl, computeLength, encode, getRequestName, removeControl, setMessageId, setRequestName

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.SingleReplyRequestDecorator

abandon, addAbandonListener, getResponseType, isAbandoned

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.ResultResponseRequestDecorator

getResultResponse, hasResponse

Methods inherited from class org.apache.directory.api.ldap.codec.api.MessageDecorator

get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, setControlsLength, setMessageLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, 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.ResultResponseRequest

getResultResponse

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

Field Detail

LOG

private static final org.slf4j.Logger LOG

gracefulSequenceLength

private int gracefulSequenceLength

Length of the sequence

gracefulShutdownRequest

private GracefulShutdownRequest gracefulShutdownRequest

Constructor Detail

GracefulShutdownRequestDecorator

public GracefulShutdownRequestDecorator(LdapApiService codec,
                                        GracefulShutdownRequest decoratedMessage)

Creates a new instance of GracefulShutdownRequestDecorator.

Parameters:

codec -

decoratedMessage -

Method Detail

setRequestValue

public void setRequestValue(byte[] requestValue)

Overrides:

setRequestValue in class ExtendedRequestDecorator<GracefulShutdownRequest>

getRequestValue

public byte[] getRequestValue()

Overrides:

getRequestValue in class ExtendedRequestDecorator<GracefulShutdownRequest>

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

computeLengthInternal

int computeLengthInternal()

Compute the GracefulShutdown length

 0x30 L1 
   | 
   +--> [0x02 0x0(1-4) [0..720] ] 
   +--> [0x80 0x0(1-3) [0..86400] ] 
 

L1 will always be < 11.

encodeInternal

java.nio.ByteBuffer encodeInternal()
                            throws EncoderException

Encodes the gracefulShutdown extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.

toString

public java.lang.String toString()

Return a string representation of the graceful shutdown

Overrides:

toString in class MessageDecorator<GracefulShutdownRequest>