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

Interface UnbindRequest

All Superinterfaces:

Message, Request

All Known Implementing Classes:

UnbindRequestDecorator, UnbindRequestImpl

public interface UnbindRequest
extends Request

Unbind protocol request message used to end a client session.

Method Summary

Modifier and Type	Method and Description
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

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

Method Detail

setMessageId

UnbindRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface Message

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

UnbindRequest addControl(Control control)

Adds a control to this Message.

Specified by:

addControl in interface Message

Parameters:

control - the control to add.

Returns:

A Message reference

addAllControls

UnbindRequest addAllControls(Control[] controls)

Adds an array of controls to this Message.

Specified by:

addAllControls in interface Message

Parameters:

controls - the controls to add.

Returns:

A Message reference

removeControl

UnbindRequest removeControl(Control control)

Deletes a control removing it from this Message.

Specified by:

removeControl in interface Message

Parameters:

control - the control to remove.

Returns:

A Message reference