Package de.elo.ix.client.plugin

Class PluginMessage

java.lang.Object
byps.BValueClass
de.elo.ix.client.plugin.PluginMessage
All Implemented Interfaces:
Serializable
public class PluginMessage extends byps.BValueClass
A message that can be sent to or received from a plugin.
Since:
11.00.000.018
See Also:

  • Field Details

    • source

      protected PluginMessageSource source
      Message source. Read only.

    • id

      protected long id
      Message ID.

    • uri

      protected String uri
      Message URI.

    • parameters

      protected Map<String,String> parameters
      String parameters.

    • bytes

      protected Map<String,byte[]> bytes
      Byte array parameters. In case of a HTTP request or response, this element can contain the response data at map key PluginMessageC.BODY.

    • objects

      protected Map<String,byps.BValueClass> objects
      API object parameters. E.g. Sord objects. In case of a HTTP request or response, this element is ignored.

    • streams

      protected Map<String,InputStream> streams
      Stream parameters. In case of a HTTP request or response, this element can contain the response data at map key PluginMessageC.BODY.

    • status

      protected int status
      Message response status code. In case of a HTTP request, this element specifies the response status code. A value of 0 is implicitly mapped to 200.

  • Constructor Details

    • PluginMessage

      public PluginMessage()

    • PluginMessage

      public PluginMessage(PluginMessage rhs)

  • Method Details

    • getId

      public long getId()

    • getUri

      public String getUri()
      Get member uri
      Returns:
      uri or empty string, not null.

    • getParameters

      public Map<String,String> getParameters()
      Get member parameters
      Returns:
      params or empty map, not null.

    • getBytes

      public Map<String,byte[]> getBytes()
      Get member bytes
      Returns:
      bytes or empty map, not null.

    • getObjects

      public Map<String,byps.BValueClass> getObjects()
      Get member objects
      Returns:
      objects or empty map, not null.

    • getStreams

      public Map<String,InputStream> getStreams()
      Get member streams
      Returns:
      streams or empty map, not null.

    • setId

      public void setId(long id)

    • setUri

      public void setUri(String uri)

    • setParameters

      public void setParameters(Map<String,String> params)

    • setBytes

      public void setBytes(Map<String,byte[]> bytes)

    • setObjects

      public void setObjects(Map<String,byps.BValueClass> objects)

    • setStreams

      public void setStreams(Map<String,InputStream> streams)

    • setBodyText

      public void setBodyText(String s)
      Set the given string response. Only available in Java. This function internally sets the given String as UTF-8 encoded byte array in the member bytes under key PluginMessageC.BODY.
      Parameters:
      s - response text

    • getBodyText

      public String getBodyText()
      Get the response as String. Only available in Java. Return the UTF-8 encoded String found in bytes for key PluginMessageC.BODY.
      Returns:
      response text.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getStatus

      public int getStatus()

    • setStatus

      public void setStatus(int status)

    • getSource

      public PluginMessageSource getSource()

    • setSource

      public void setSource(PluginMessageSource soure)