|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.shared.ldap.message.internal.InternalAbstractMessage
public abstract class InternalAbstractMessage
Abstract message base class.
Constructor Summary | |
---|---|
protected |
InternalAbstractMessage(int id,
MessageTypeEnum type)
Completes the instantiation of a Message. |
Method Summary | |
---|---|
void |
add(Control control)
Adds a control to this Message. |
void |
addAll(Control[] controls)
Adds an array of controls 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<java.lang.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(java.lang.String oid)
Checks whether or not this message has the specified control. |
int |
hashCode()
|
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, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected InternalAbstractMessage(int id, MessageTypeEnum type)
id
- the seq id of the messagetype
- the type of the messageMethod Detail |
---|
public int getMessageId()
getMessageId
in interface InternalMessage
public java.util.Map<java.lang.String,Control> getControls()
getControls
in interface InternalMessage
CodecControl
public boolean hasControl(java.lang.String oid)
InternalMessage
hasControl
in interface InternalMessage
oid
- the OID of the control
InternalMessage.hasControl(java.lang.String)
public void add(Control control) throws MessageException
add
in interface InternalMessage
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 InternalMessage
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 InternalMessage
public java.lang.Object get(java.lang.Object key)
get
in interface InternalMessage
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 InternalMessage
key
- the parameter keyvalue
- the parameter value
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- the object to compare this Message to for equalitypublic int hashCode()
hashCode
in class java.lang.Object
Object.hashCode()
public void addAll(Control[] controls) throws MessageException
InternalMessage
addAll
in interface InternalMessage
controls
- the controls to add.
MessageException
- if controls cannot be added to this Message or they are not known etc.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |