org.apache.directory.shared.ldap.extras.extended
Class GracefulShutdownResponse

java.lang.Object
  org.apache.directory.shared.ldap.model.message.AbstractMessage
      org.apache.directory.shared.ldap.model.message.AbstractResponse
          org.apache.directory.shared.ldap.model.message.AbstractResultResponse
              org.apache.directory.shared.ldap.model.message.ExtendedResponseImpl
                  org.apache.directory.shared.ldap.extras.extended.GracefulShutdownResponse

All Implemented Interfaces:

Serializable, ExtendedResponse, Message, Response, ResultResponse

public class GracefulShutdownResponse
extends ExtendedResponseImpl

The response sent back from the server when a GracefulShutdownRequest extended operation is sent. Delivery of this response may block until all connected clients are sent a GracefulDisconnect unsolicited notification.

Author:

Apache Directory Project

See Also:

Serialized Form

Field Summary

static String

EXTENSION_OID The OID for the graceful shutdown extended operation response.

Fields inherited from class org.apache.directory.shared.ldap.model.message.ExtendedResponseImpl

responseName, responseValue

Fields inherited from class org.apache.directory.shared.ldap.model.message.AbstractResultResponse

ldapResult

Fields inherited from class org.apache.directory.shared.ldap.model.message.AbstractMessage

controls

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

TYPE

Constructor Summary

GracefulShutdownResponse(int messageId)
Instantiates a new graceful shutdown response.

GracefulShutdownResponse(int messageId, ResultCodeEnum rcode)
Instantiates a new graceful shutdown response.

Method Summary

boolean	equals(Object obj)
byte[]	getResponse() Gets the reponse OID specific encoded response values.
String	getResponseName() Gets the OID uniquely identifying this extended response (a.k.a.
int	hashCode()
void	setResponse(byte[] value) Sets the reponse OID specific encoded response values.
void	setResponseName(String oid) Sets the OID uniquely identifying this extended response (a.k.a.

Methods inherited from class org.apache.directory.shared.ldap.model.message.ExtendedResponseImpl

getEncodedValue, getID, getResponseValue, setResponseValue, toString

Methods inherited from class org.apache.directory.shared.ldap.model.message.AbstractResultResponse

getLdapResult

Methods inherited from class org.apache.directory.shared.ldap.model.message.AbstractMessage

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getLdapResult

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

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

Field Detail

EXTENSION_OID

public static final String EXTENSION_OID

The OID for the graceful shutdown extended operation response.

See Also:

Constant Field Values

Constructor Detail

GracefulShutdownResponse

public GracefulShutdownResponse(int messageId,
                                ResultCodeEnum rcode)

Instantiates a new graceful shutdown response.

Parameters:

messageId - the message id

rcode - the result code

GracefulShutdownResponse

public GracefulShutdownResponse(int messageId)

Instantiates a new graceful shutdown response.

Parameters:

messageId - the message id

Method Detail

getResponse

public byte[] getResponse()

Gets the reponse OID specific encoded response values.

Returns:

the response specific encoded response values.

setResponse

public void setResponse(byte[] value)

Sets the reponse OID specific encoded response values.

Parameters:

value - the response specific encoded response values.

getResponseName

public String getResponseName()

Gets the OID uniquely identifying this extended response (a.k.a. its name).

Overrides:

getResponseName in class ExtendedResponseImpl

Returns:

the OID of the extended response type.

setResponseName

public void setResponseName(String oid)

Sets the OID uniquely identifying this extended response (a.k.a. its name).

Overrides:

setResponseName in class ExtendedResponseImpl

Parameters:

oid - the OID of the extended response type.

hashCode

public int hashCode()

Overrides:

hashCode in class ExtendedResponseImpl

equals

public boolean equals(Object obj)

Overrides:

equals in class ExtendedResponseImpl