org.apache.directory.shared.ldap.message.extended
Class GracefulDisconnect

java.lang.Object
  extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
      extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractResponse
          extended by org.apache.directory.shared.ldap.message.internal.InternalAbstractResultResponse
              extended by org.apache.directory.shared.ldap.message.ExtendedResponseImpl
                  extended by org.apache.directory.shared.ldap.message.extended.GracefulDisconnect
All Implemented Interfaces:
java.io.Serializable, javax.naming.ldap.ExtendedResponse, InternalExtendedResponse, InternalMessage, InternalResponse, InternalResultResponse

public class GracefulDisconnect
extends ExtendedResponseImpl

An unsolicited notification, extended response, intended for notifying clients of upcoming disconnection due to intended service windows. Unlike the NoticeOfDisconnect this response contains additional information about the amount of time the server will be offline and exactly when it intends to shutdown.

Version:
$Rev: 912436 $
Author:
Apache Directory Project
See Also:
Serialized Form

Field Summary
static java.lang.String EXTENSION_OID
           
 
Fields inherited from class org.apache.directory.shared.ldap.message.ExtendedResponseImpl
oid, value
 
Fields inherited from interface org.apache.directory.shared.ldap.message.internal.InternalExtendedResponse
TYPE
 
Constructor Summary
GracefulDisconnect(byte[] value)
           
GracefulDisconnect(int timeOffline, int delay)
           
 
Method Summary
 int getDelay()
           
 InternalReferral getReplicatedContexts()
           
 byte[] getResponse()
          Gets the reponse OID specific encoded response values.
 java.lang.String getResponseName()
          Gets the OID uniquely identifying this extended response (a.k.a.
 int getTimeOffline()
           
 void setDelay(int delay)
           
 void setResponse(byte[] value)
          Sets the reponse OID specific encoded response values.
 void setResponseName(java.lang.String oid)
          Sets the OID uniquely identifying this extended response (a.k.a.
 void setTimeOffline(int timeOffline)
           
 
Methods inherited from class org.apache.directory.shared.ldap.message.ExtendedResponseImpl
equals, getEncodedValue, getID, setOid
 
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractResultResponse
getLdapResult, toString
 
Methods inherited from class org.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
add, addAll, get, getControls, getMessageId, getType, hasControl, hashCode, put, remove
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalResultResponse
getLdapResult
 
Methods inherited from interface org.apache.directory.shared.ldap.message.internal.InternalMessage
add, addAll, get, getControls, getMessageId, getType, hasControl, put, remove
 

Field Detail

EXTENSION_OID

public static final java.lang.String EXTENSION_OID
See Also:
Constant Field Values
Constructor Detail

GracefulDisconnect

public GracefulDisconnect(byte[] value)
                   throws DecoderException
Throws:
DecoderException

GracefulDisconnect

public GracefulDisconnect(int timeOffline,
                          int delay)
Method Detail

getResponse

public byte[] getResponse()
Gets the reponse OID specific encoded response values.

Specified by:
getResponse in interface InternalExtendedResponse
Overrides:
getResponse in class ExtendedResponseImpl
Returns:
the response specific encoded response values.

setResponse

public void setResponse(byte[] value)
Sets the reponse OID specific encoded response values.

Specified by:
setResponse in interface InternalExtendedResponse
Overrides:
setResponse in class ExtendedResponseImpl
Parameters:
value - the response specific encoded response values.

getResponseName

public java.lang.String getResponseName()
Gets the OID uniquely identifying this extended response (a.k.a. its name).

Specified by:
getResponseName in interface InternalExtendedResponse
Overrides:
getResponseName in class ExtendedResponseImpl
Returns:
the OID of the extended response type.

setResponseName

public void setResponseName(java.lang.String oid)
Sets the OID uniquely identifying this extended response (a.k.a. its name).

Specified by:
setResponseName in interface InternalExtendedResponse
Overrides:
setResponseName in class ExtendedResponseImpl
Parameters:
oid - the OID of the extended response type.

setDelay

public void setDelay(int delay)

setTimeOffline

public void setTimeOffline(int timeOffline)

getDelay

public int getDelay()

getTimeOffline

public int getTimeOffline()

getReplicatedContexts

public InternalReferral getReplicatedContexts()


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.