org.apache.directory.shared.ldap.message
Interface Message
- All Known Subinterfaces:
- AbandonableRequest, AbandonRequest, AddRequest, AddResponse, BindRequest, BindResponse, CompareRequest, CompareResponse, DeleteRequest, DeleteResponse, ExtendedRequest, ExtendedResponse, ManyReplyRequest, ModifyDnRequest, ModifyDnResponse, ModifyRequest, ModifyResponse, Request, Response, ResultResponse, ResultResponseRequest, SearchRequest, SearchResponseDone, SearchResponseEntry, SearchResponseReference, SingleReplyRequest, UnbindRequest
- All Known Implementing Classes:
- AbandonRequestImpl, AbstractAbandonableRequest, AbstractMessage, AbstractRequest, AbstractResponse, AbstractResultResponse, AddRequestImpl, AddResponseImpl, BindRequestImpl, BindResponseImpl, CompareRequestImpl, CompareResponseImpl, DeleteRequestImpl, DeleteResponseImpl, ExtendedRequestImpl, ExtendedResponseImpl, ModifyDnRequestImpl, ModifyDnResponseImpl, ModifyRequestImpl, ModifyResponseImpl, SearchRequestImpl, SearchResponseDoneImpl, SearchResponseEntryImpl, SearchResponseReferenceImpl, UnbindRequestImpl
- public interface Message
Root interface for all LDAP message type interfaces.
- Version:
- $Rev: 379008 $
- Author:
- Apache Directory Project
Method Summary |
void |
add(Control control)
Adds a control to this Message. |
java.lang.Object |
get(java.lang.Object key)
Gets a message scope parameter. |
java.util.Map |
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. |
java.lang.Object |
put(java.lang.Object key,
java.lang.Object value)
Sets a message scope parameter. |
void |
remove(Control control)
Deletes a control removing it from this Message. |
getType
public 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
public java.util.Map getControls()
- Gets the controls associated with this message mapped by OID.
- Returns:
- Map of OID strings to Control object instances.
- See Also:
Control
add
public void add(Control control)
throws MessageException
- Adds a control to this Message.
- Parameters:
control
- the control to add.
- Throws:
MessageException
- if controls cannot be added to this Message or the control is
not known etc.
remove
public void remove(Control control)
throws MessageException
- Deletes a control removing it from this Message.
- Parameters:
control
- the control to remove.
- Throws:
MessageException
- if controls cannot be added to this Message or the control is
not known etc.
getMessageId
public 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
public java.lang.Object get(java.lang.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
public java.lang.Object put(java.lang.Object key,
java.lang.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 keyvalue
- the parameter value
- Returns:
- the old value or null
Copyright © 2003-2006 . All Rights Reserved.