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.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>

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

All Implemented Interfaces:

org.apache.directory.api.asn1.Asn1Object, org.apache.directory.api.ldap.codec.api.Decorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>, org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest, org.apache.directory.api.ldap.model.message.AbandonableRequest, org.apache.directory.api.ldap.model.message.ExtendedRequest, org.apache.directory.api.ldap.model.message.Message, org.apache.directory.api.ldap.model.message.Request, org.apache.directory.api.ldap.model.message.ResultResponseRequest, org.apache.directory.api.ldap.model.message.SingleReplyRequest

public class GracefulShutdownRequestDecorator
extends org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>
implements org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

A Decorator for GracefulShutdownRequests.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
private int	gracefulSequenceLength Length of the sequence
private org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest	gracefulShutdownRequest
private static org.slf4j.Logger	LOG

Fields inherited from class org.apache.directory.api.ldap.codec.decorators.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(org.apache.directory.api.ldap.codec.api.LdapApiService codec, org.apache.directory.api.ldap.extras.extended.gracefulShutdown.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) ByteBuffer	encodeInternal() Encodes the gracefulShutdown extended operation.
int	getDelay()
byte[]	getRequestValue()
int	getTimeOffline()
void	setDelay(int delay)
void	setRequestValue(byte[] requestValue)
void	setTimeOffline(int timeOffline)
String	toString() Return a string representation of the graceful shutdown

Methods inherited from class org.apache.directory.api.ldap.codec.decorators.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 org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest gracefulShutdownRequest

Constructor Detail

GracefulShutdownRequestDecorator

public GracefulShutdownRequestDecorator(org.apache.directory.api.ldap.codec.api.LdapApiService codec,
                                        org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest decoratedMessage)

Creates a new instance of GracefulShutdownRequestDecorator.

Parameters:

codec - The LDAP Service to use

decoratedMessage - The GracefulShutdownRequest control to decorate

Method Detail

setRequestValue

public void setRequestValue(byte[] requestValue)

Overrides:

setRequestValue in class org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>

getRequestValue

public byte[] getRequestValue()

Overrides:

getRequestValue in class org.apache.directory.api.ldap.codec.decorators.ExtendedRequestDecorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>

getDelay

public int getDelay()

Specified by:

getDelay in interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

setDelay

public void setDelay(int delay)

Specified by:

setDelay in interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

getTimeOffline

public int getTimeOffline()

Specified by:

getTimeOffline in interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

setTimeOffline

public void setTimeOffline(int timeOffline)

Specified by:

setTimeOffline in interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest

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

ByteBuffer encodeInternal()
                   throws org.apache.directory.api.asn1.EncoderException

Encodes the gracefulShutdown extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

org.apache.directory.api.asn1.EncoderException - If anything goes wrong.

toString

public String toString()

Return a string representation of the graceful shutdown

Overrides:

toString in class org.apache.directory.api.ldap.codec.api.MessageDecorator<org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownRequest>