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

Class GracefulDisconnectResponseDecorator

java.lang.Object

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

org.apache.directory.api.ldap.codec.decorators.ResponseDecorator<R>

org.apache.directory.api.ldap.codec.api.ExtendedResponseDecorator<GracefulDisconnectResponse>

org.apache.directory.api.ldap.extras.extended.ads_impl.gracefulDisconnect.GracefulDisconnectResponseDecorator

All Implemented Interfaces:

Asn1Object, Decorator<GracefulDisconnectResponse>, GracefulDisconnectResponse, ExtendedResponse, Message, Response, ResultResponse

public class GracefulDisconnectResponseDecorator
extends ExtendedResponseDecorator<GracefulDisconnectResponse>
implements GracefulDisconnectResponse

A Decorator for CancelResponses.

Field Summary

Fields

Modifier and Type	Field and Description
private GracefulDisconnectResponse	gracefulDisconnectResponse
private int	gracefulDisconnectSequenceLength Length of the sequence
private java.util.List<byte[]>	ldapUrlBytes The encoded LDAP URL list
private static org.slf4j.Logger	LOG The logger.
private int	replicatedContextsLength Length of the replicated contexts

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

responseValue

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

messageLength

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.gracefulDisconnect.GracefulDisconnectResponse

EXTENSION_OID

Fields inherited from interface org.apache.directory.api.ldap.model.message.ExtendedResponse

TYPE

Constructor Summary

Constructors

Constructor and Description
GracefulDisconnectResponseDecorator(LdapApiService codec, GracefulDisconnectResponse decoratedMessage) Creates a new instance of CancelResponseDecorator.

Method Summary

Modifier and Type	Method and Description
void	addReplicatedContexts(java.lang.String replicatedContext) Add a new URL of a replicated server
(package private) int	computeLengthInternal() Compute the GracefulDisconnect length
(package private) java.nio.ByteBuffer	encodeInternal() Encodes the gracefulDisconnect extended operation.
int	getDelay() Gets the delay before disconnection, in seconds.
Referral	getReplicatedContexts() Gets the replicated contexts.
byte[]	getResponseValue() Gets the response OID specific encoded response values.
int	getTimeOffline() Gets the offline time after disconnection, in minutes.
void	setDelay(int delay) Sets the delay before disconnection, in seconds.
void	setResponseValue(byte[] responseValue) Sets the response OID specific encoded response values.
void	setTimeOffline(int timeOffline) Sets the time offline after disconnection, in minutes.
java.lang.String	toString() Return a string representation of the graceful disconnect

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

computeLength, encode, getResponseName, setResponseName

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

getLdapResult, setLdapResult

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

addAllControls, addControl, get, getCodecService, getControl, getControls, getControlsLength, getCurrentControl, getDecorated, getDecorator, getMessageId, getMessageLength, getType, hasControl, put, removeControl, setControlsLength, setMessageId, 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.ExtendedResponse

getResponseName, setResponseName

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

getLdapResult

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

addAllControls, addControl, get, getControl, getControls, getMessageId, getType, hasControl, put, removeControl, setMessageId

Field Detail

LOG

private static final org.slf4j.Logger LOG

The logger.

gracefulDisconnectSequenceLength

private int gracefulDisconnectSequenceLength

Length of the sequence

replicatedContextsLength

private int replicatedContextsLength

Length of the replicated contexts

ldapUrlBytes

private java.util.List<byte[]> ldapUrlBytes

The encoded LDAP URL list

gracefulDisconnectResponse

private GracefulDisconnectResponse gracefulDisconnectResponse

Constructor Detail

GracefulDisconnectResponseDecorator

public GracefulDisconnectResponseDecorator(LdapApiService codec,
                                           GracefulDisconnectResponse decoratedMessage)

Creates a new instance of CancelResponseDecorator.

Parameters:

codec -

decoratedMessage -

Method Detail

getResponseValue

public byte[] getResponseValue()

Gets the response OID specific encoded response values.

Overrides:

getResponseValue in class ExtendedResponseDecorator<GracefulDisconnectResponse>

Returns:

the response specific encoded response values.

setResponseValue

public void setResponseValue(byte[] responseValue)

Sets the response OID specific encoded response values.

Overrides:

setResponseValue in class ExtendedResponseDecorator<GracefulDisconnectResponse>

Parameters:

responseValue - the response specific encoded response values.

getDelay

public int getDelay()

Gets the delay before disconnection, in seconds.

Specified by:

getDelay in interface GracefulDisconnectResponse

Returns:

the delay before disconnection

setDelay

public void setDelay(int delay)

Sets the delay before disconnection, in seconds.

Specified by:

setDelay in interface GracefulDisconnectResponse

Parameters:

delay - the new delay before disconnection

getTimeOffline

public int getTimeOffline()

Gets the offline time after disconnection, in minutes.

Specified by:

getTimeOffline in interface GracefulDisconnectResponse

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 GracefulDisconnectResponse

Parameters:

timeOffline - the new time offline after disconnection

getReplicatedContexts

public Referral getReplicatedContexts()

Gets the replicated contexts.

Specified by:

getReplicatedContexts in interface GracefulDisconnectResponse

Returns:

the replicated contexts

addReplicatedContexts

public void addReplicatedContexts(java.lang.String replicatedContext)

Add a new URL of a replicated server

Specified by:

addReplicatedContexts in interface GracefulDisconnectResponse

Parameters:

replicatedContext - The replicated server to add.

computeLengthInternal

int computeLengthInternal()

Compute the GracefulDisconnect length

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

encodeInternal

java.nio.ByteBuffer encodeInternal()
                            throws EncoderException

Encodes the gracefulDisconnect 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 disconnect

Overrides:

toString in class MessageDecorator<GracefulDisconnectResponse>