.. java:import:: java.util HashMap

.. java:import:: java.util Map

.. java:import:: java.util Map.Entry

.. java:import:: org.jdom2 Attribute

.. java:import:: org.jdom2 Element

ClientMessage
=============

.. java:package:: org.caosdb.server.entity
   :noindex:

.. java:type:: public class ClientMessage extends Message

   Class which represents client messages. Client messages is a way to extend the Entity API with special properties which may be used by plug-ins.

   If no plug-in handles the client message, it is printed back to the response unaltered.

   Client message can have arbitrary key-value (string-string typed) tuples \ :java:ref:`properties`\ .

   :author: Timm Fitschen (t.fitschen@indiscale.com)

Constructors
------------
ClientMessage
^^^^^^^^^^^^^

.. java:constructor:: public ClientMessage(String type, String body)
   :outertype: ClientMessage

Methods
-------
addToElement
^^^^^^^^^^^^

.. java:method:: @Override public void addToElement(Element parent)
   :outertype: ClientMessage

fromXML
^^^^^^^

.. java:method:: public static ClientMessage fromXML(Element pe)
   :outertype: ClientMessage

   NB: This is the only place where properties are set in this class.

getProperty
^^^^^^^^^^^

.. java:method:: public String getProperty(String key)
   :outertype: ClientMessage

hashCode
^^^^^^^^

.. java:method:: @Override public int hashCode()
   :outertype: ClientMessage

toElement
^^^^^^^^^

.. java:method:: @Override public Element toElement()
   :outertype: ClientMessage

toString
^^^^^^^^

.. java:method:: @Override public String toString()
   :outertype: ClientMessage