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

All Known Subinterfaces:

AbandonableRequest, AbandonRequest, AddRequest, AddResponse, BindRequest, BindResponse, CompareRequest, CompareResponse, DeleteRequest, DeleteResponse, ExtendedRequest<R>, ExtendedResponse, IntermediateResponse, ManyReplyRequest<R>, ModifyDnRequest, ModifyDnResponse, ModifyRequest, ModifyResponse, Request, Response, ResultResponse, ResultResponseRequest<R>, SearchRequest, SearchResultDone, SearchResultEntry, SearchResultReference, SingleReplyRequest<R>, UnbindRequest

All Known Implementing Classes:

AbandonRequestImpl, AbstractAbandonableRequest, AbstractExtendedRequest, AbstractMessage, AbstractRequest, AbstractResponse, AbstractResultResponse, AddNoDResponse, AddRequestImpl, AddResponseImpl, BindNoDResponse, BindRequestImpl, BindResponseImpl, CompareNoDResponse, CompareRequestImpl, CompareResponseImpl, DeleteNoDResponse, DeleteRequestImpl, DeleteResponseImpl, ExtendedNoDResponse, ExtendedRequestImpl, ExtendedResponseImpl, IntermediateResponseImpl, ModifyDnNoDResponse, ModifyDnRequestImpl, ModifyDnResponseImpl, ModifyNoDResponse, ModifyRequestImpl, ModifyResponseImpl, NoticeOfDisconnect, SearchNoDResponse, SearchRequestImpl, SearchResultDoneImpl, SearchResultEntryImpl, SearchResultReferenceImpl, UnbindRequestImpl

public interface Message

Root interface for all LDAP message type interfaces.

Author:

Apache Directory Project

Method Summary

Message	addAllControls(Control[] controls) Adds an array of controls to this Message.
Message	addControl(Control control) Adds a control to this Message.
Object	get(Object key) Gets a message scope parameter.
Control	getControl(String oid) Gets the control associated with the given OID.
Map<String,Control>	getControls() Gets the controls associated with this message mapped by OID.
int	getMessageId() Gets the session unique message sequence id for this message.
MessageTypeEnum	getType() Gets the LDAP message type code associated with this Message.
boolean	hasControl(String oid) Checks whether or not this message has the specified control.
Object	put(Object key, Object value) Sets a message scope parameter.
Message	removeControl(Control control) Deletes a control removing it from this Message.
Message	setMessageId(int messageId) Sets the Message ID for this request

Method Detail

getType

MessageTypeEnum getType()

Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.

Returns:

the message type code.

getControls

Map<String,Control> getControls()

Gets the controls associated with this message mapped by OID.

Returns:

Map of OID strings to Control object instances.

getControl

Control getControl(String oid)

Gets the control associated with the given OID.

Parameters:

oid - The Cntrol's OID we are looking for

Returns:

The Control object instance with the OID.

hasControl

boolean hasControl(String oid)

Checks whether or not this message has the specified control.

Parameters:

oid - the OID of the control

Returns:

true if this message has the control, false if it does not

addControl

Message addControl(Control control)
                   throws MessageException

Adds a control to this Message.

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

Message addAllControls(Control[] controls)
                       throws MessageException

Adds an array of controls to this Message.

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

Message removeControl(Control control)
                      throws MessageException

Deletes a control removing it from this Message.

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.

getMessageId

int getMessageId()

Gets the session unique message sequence id for this message. Requests and their responses if any have the same message id. Clients at the initialization of a session start with the first message's id set to 1 and increment it with each transaction.

Returns:

the session unique message id.

get

Object get(Object key)

Gets a message scope parameter. Message scope parameters are temporary variables associated with a message and are set locally to be used to associate housekeeping information with a request or its processing. These parameters are never transmitted nor recieved, think of them as transient data associated with the message or its processing. These transient parameters are not locked down so modifications can occur without firing LockExceptions even when this Lockable is in the locked state.

Parameters:

key - the key used to access a message parameter.

Returns:

the transient message parameter value.

put

Object put(Object key,
           Object value)

Sets a message scope parameter. These transient parameters are not locked down so modifications can occur without firing LockExceptions even when this Lockable is in the locked state.

Parameters:

key - the parameter key

value - the parameter value

Returns:

the old value or null

setMessageId

Message setMessageId(int messageId)

Sets the Message ID for this request

Parameters:

messageId - The message Id

Returns:

A Message reference