|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.AbstractMessage
Abstract message base class.
Constructor Summary | |
protected |
AbstractMessage(int id,
MessageTypeEnum type)
Completes the instantiation of a Message. |
Method Summary | |
void |
add(Control control)
Adds a control to this Message. |
boolean |
equals(java.lang.Object obj)
Checks to see if two messages are equivalent. |
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. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected AbstractMessage(int id, MessageTypeEnum type)
id
- the seq id of the messagetype
- the type of the messageMethod Detail |
public int getMessageId()
getMessageId
in interface Message
public java.util.Map getControls()
getControls
in interface Message
Control
public void add(Control control) throws MessageException
add
in interface Message
control
- the control to add.
MessageException
- if controls cannot be added to this Message or the control is
not known etc.public void remove(Control control) throws MessageException
remove
in interface Message
control
- the control to remove.
MessageException
- if controls cannot be added to this Message or the control is
not known etc.public MessageTypeEnum getType()
getType
in interface Message
public java.lang.Object get(java.lang.Object key)
get
in interface Message
key
- the key used to access a message parameter.
public java.lang.Object put(java.lang.Object key, java.lang.Object value)
put
in interface Message
key
- the parameter keyvalue
- the parameter value
public boolean equals(java.lang.Object obj)
obj
- the object to compare this Message to for equality
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |