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

Class GracefulShutdownResponseImpl

java.lang.Object

org.apache.directory.api.ldap.model.message.AbstractMessage

org.apache.directory.api.ldap.model.message.AbstractResponse

org.apache.directory.api.ldap.model.message.AbstractResultResponse

org.apache.directory.api.ldap.model.message.ExtendedResponseImpl

org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownResponseImpl

All Implemented Interfaces:

GracefulShutdownResponse, ExtendedResponse, Message, Response, ResultResponse

public class GracefulShutdownResponseImpl
extends ExtendedResponseImpl
implements GracefulShutdownResponse

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

Author:

Apache Directory Project

Field Summary

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

responseName

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

ldapResult

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

controls

Fields inherited from interface org.apache.directory.api.ldap.extras.extended.gracefulShutdown.GracefulShutdownResponse

EXTENSION_OID

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

TYPE

Constructor Summary

Constructors

Constructor and Description
GracefulShutdownResponseImpl() Instantiates a new graceful shutdown response.
GracefulShutdownResponseImpl(int messageId) Instantiates a new graceful shutdown response.
GracefulShutdownResponseImpl(int messageId, ResultCodeEnum rcode) Instantiates a new graceful shutdown response.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Checks to see if an object equals this ExtendedRequest.
String	getResponseName() Gets the OID uniquely identifying this extended response (a.k.a.
int	hashCode()
void	setResponseName(String oid) Sets the OID uniquely identifying this extended response (a.k.a.

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

toString

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

getLdapResult

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

GracefulShutdownResponseImpl

public GracefulShutdownResponseImpl(int messageId,
                                    ResultCodeEnum rcode)

Instantiates a new graceful shutdown response.

Parameters:

messageId - the message id

rcode - the result code

GracefulShutdownResponseImpl

public GracefulShutdownResponseImpl(int messageId)

Instantiates a new graceful shutdown response.

Parameters:

messageId - the message id

GracefulShutdownResponseImpl

public GracefulShutdownResponseImpl()

Instantiates a new graceful shutdown response.

Method Detail

getResponseName

public String getResponseName()

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

Specified by:

getResponseName in interface ExtendedResponse

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).

Specified by:

setResponseName in interface ExtendedResponse

Overrides:

setResponseName in class ExtendedResponseImpl

Parameters:

oid - the OID of the extended response type.

hashCode

public int hashCode()

Overrides:

hashCode in class ExtendedResponseImpl

Returns:

the instance's hash code

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Checks to see if an object equals this ExtendedRequest.

Overrides:

equals in class ExtendedResponseImpl

Parameters:

obj - the object to be checked for equality

Returns:

true if the obj equals this ExtendedRequest, false otherwise