public abstract class AbstractMessage extends Object implements Message
Modifier and Type | Field and Description |
---|---|
protected Map<String,Control> |
controls
Map of message controls using OID Strings for keys and Control values
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractMessage(int id,
MessageTypeEnum type)
Completes the instantiation of a Message.
|
Modifier and Type | Method and Description |
---|---|
Message |
addAllControls(Control[] controls)
Adds an array of controls to this Message.
|
Message |
addControl(Control control)
Adds a control to this Message.
|
boolean |
equals(Object obj)
Checks to see if two messages are equivalent.
|
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.
|
int |
hashCode() |
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 id)
Sets the Message ID for this request
|
String |
toString(String message)
Get a String representation of a LdapMessage
|
protected AbstractMessage(int id, MessageTypeEnum type)
id
- the seq id of the messagetype
- the type of the messagepublic int getMessageId()
getMessageId
in interface Message
public Message setMessageId(int id)
setMessageId
in interface Message
id
- The message Idpublic Map<String,Control> getControls()
getControls
in interface Message
public Control getControl(String oid)
getControl
in interface Message
oid
- The Cntrol's OID we are looking forpublic boolean hasControl(String oid)
hasControl
in interface Message
oid
- the OID of the controlpublic Message addControl(Control control) throws MessageException
addControl
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 Message removeControl(Control control) throws MessageException
removeControl
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()
public Object get(Object key)
public Object put(Object key, Object value)
public boolean equals(Object obj)
public int hashCode()
hashCode
in class Object
Object.hashCode()
public Message addAllControls(Control[] controls) throws MessageException
addAllControls
in interface Message
controls
- the controls to add.MessageException
- if controls cannot be added to this Message or they are not known etc.Copyright © 2003-2014 The Apache Software Foundation. All Rights Reserved.