org.apache.directory.shared.ldap.codec.extended.operations.gracefulDisconnect

Class GracefulDisconnect

java.lang.Object

org.apache.directory.shared.asn1.AbstractAsn1Object

org.apache.directory.shared.ldap.codec.extended.operations.GracefulAction

org.apache.directory.shared.ldap.codec.extended.operations.gracefulDisconnect.GracefulDisconnect

All Implemented Interfaces:

Asn1Object

public class GracefulDisconnect
extends GracefulAction

An extended operation to proceed a graceful disconnect

   GracefulDisconnect ::= SEQUENCE 
   {
       timeOffline           INTEGER (0..720) DEFAULT 0,
       delay             [0] INTEGER (0..86400) DEFAULT 0,
       replicatedContexts    Referral OPTIONAL
   }
 

Version:

$Rev: 910150 $, $Date: 2010-02-15 02:37:34 +0100(lun, 15 feb 2010) $,

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.shared.ldap.codec.extended.operations.GracefulAction

delay, NOW, timeOffline, UNDETERMINED

Fields inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

parent

Constructor Summary

Constructors

Constructor and Description
GracefulDisconnect() Default constructor.
GracefulDisconnect(int timeOffline, int delay) Create a GracefulDisconnect object, with a timeOffline and a delay

Method Summary

Modifier and Type	Method and Description
void	addReplicatedContexts(LdapURL replicatedContext) Add a new URL of a replicated server
int	computeLength() Compute the GracefulDisconnect length 0x30 L1 | +--> [ 0x02 0x0(1-4) [0..720] ] +--> [ 0x80 0x0(1-3) [0..86400] ] +--> [ 0x30 L2 | +--> (0x04 L3 value) + ]
ByteBuffer	encode() Encodes the gracefulDisconnect extended operation.
List<LdapURL>	getReplicatedContexts() Get the list of replicated servers
String	toString() Return a string representation of the graceful disconnect

Methods inherited from class org.apache.directory.shared.ldap.codec.extended.operations.GracefulAction

getDelay, getTimeOffline, setDelay, setTimeOffline

Methods inherited from class org.apache.directory.shared.asn1.AbstractAsn1Object

addLength, encode, getCurrentLength, getExpectedLength, getParent, getTlvId, setCurrentLength, setExpectedLength, setParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GracefulDisconnect

public GracefulDisconnect(int timeOffline,
                          int delay)

Create a GracefulDisconnect object, with a timeOffline and a delay

Parameters:

timeOffline - The time the server will be offline

delay - The delay before the disconnection

GracefulDisconnect

public GracefulDisconnect()

Default constructor.

Method Detail

getReplicatedContexts

public List<LdapURL> getReplicatedContexts()

Get the list of replicated servers

Returns:

The list of replicated servers

addReplicatedContexts

public void addReplicatedContexts(LdapURL replicatedContext)

Add a new URL of a replicated server

Parameters:

replicatedContext - The replictaed server to add.

computeLength

public int computeLength()

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

Specified by:

computeLength in interface Asn1Object

Specified by:

computeLength in class AbstractAsn1Object

Returns:

The object's computed length

encode

public ByteBuffer encode()
                  throws EncoderException

Encodes the gracefulDisconnect extended operation.

Returns:

A ByteBuffer that contains the encoded PDU

Throws:

EncoderException - If anything goes wrong.

toString

public String toString()

Return a string representation of the graceful disconnect

Overrides:

toString in class Object