org.apache.directory.api.ldap.model.message
Class UnbindRequestImpl

java.lang.Object
  org.apache.directory.api.ldap.model.message.AbstractMessage
      org.apache.directory.api.ldap.model.message.AbstractRequest
          org.apache.directory.api.ldap.model.message.UnbindRequestImpl

All Implemented Interfaces:

Message, Request, UnbindRequest

public class UnbindRequestImpl
extends AbstractRequest
implements UnbindRequest

Lockable UnbindRequest implementation.

Author:

Apache Directory Project

Field Summary

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

controls

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

TYPE

Constructor Summary

UnbindRequestImpl()
Creates an UnbindRequest which takes no parameter other than those in the outer envelope to disconnect and end a client session on the server without producing any response.

Method Summary

void	abandon() RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.
UnbindRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
UnbindRequest	addControl(Control control) Adds a control to this Message.
UnbindRequest	removeControl(Control control) Deletes a control removing it from this Message.
UnbindRequest	setMessageId(int messageId) Sets the Message ID for this request
String	toString() Get a String representation of a UnBindRequest

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

equals, hashCode, hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put, 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.Request

hasResponse

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

get, getControl, getControls, getMessageId, getType, hasControl, put

Constructor Detail

UnbindRequestImpl

public UnbindRequestImpl()

Creates an UnbindRequest which takes no parameter other than those in the outer envelope to disconnect and end a client session on the server without producing any response.

Parameters:

id - the sequential message identifier.

Method Detail

abandon

public void abandon()

RFC 2251 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.

setMessageId

public UnbindRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface Message

Specified by:

setMessageId in interface UnbindRequest

Overrides:

setMessageId in class AbstractMessage

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

public UnbindRequest addControl(Control control)
                         throws MessageException

Adds a control to this Message.

Specified by:

addControl in interface Message

Specified by:

addControl in interface UnbindRequest

Overrides:

addControl in class AbstractMessage

Parameters:

control - the control to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

addAllControls

public UnbindRequest addAllControls(Control[] controls)
                             throws MessageException

Adds an array of controls to this Message.

Specified by:

addAllControls in interface Message

Specified by:

addAllControls in interface UnbindRequest

Overrides:

addAllControls in class AbstractMessage

Parameters:

controls - the controls to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or they are not known etc.

removeControl

public UnbindRequest removeControl(Control control)
                            throws MessageException

Deletes a control removing it from this Message.

Specified by:

removeControl in interface Message

Specified by:

removeControl in interface UnbindRequest

Overrides:

removeControl in class AbstractMessage

Parameters:

control - the control to remove.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

toString

public String toString()

Get a String representation of a UnBindRequest

Overrides:

toString in class Object

Returns:

A UnBindRequest String