Uses of Interface org.apache.activemq.artemis.api.core.Message (ActiveMQ Artemis Web 1.1.0.wildfly-010 API)
Date: 2015-12-18

## Uses of Interface
org.apache.activemq.artemis.api.core.Message

- Packages that use Message
  Package | Description
  --- | ---
  org.apache.activemq.artemis.api.core |
  org.apache.activemq.artemis.api.core.client |
  org.apache.activemq.artemis.api.core.management |
  org.apache.activemq.artemis.reader |
  org.apache.activemq.artemis.spi.core.remoting |

- - ### Uses of Message in org.apache.activemq.artemis.api.core

    Methods in org.apache.activemq.artemis.api.core that return Message
    Modifier and Type | Method and Description
    --- | ---
    `Message` | Message.`putBooleanProperty(SimpleString key, boolean value)` Puts a boolean property in this message.
    `Message` | Message.`putBooleanProperty(String key, boolean value)`
    `Message` | Message.`putByteProperty(SimpleString key, byte value)` Puts a byte property in this message.
    `Message` | Message.`putByteProperty(String key, byte value)`
    `Message` | Message.`putBytesProperty(SimpleString key, byte[] value)` Puts a byte[] property in this message.
    `Message` | Message.`putBytesProperty(String key, byte[] value)`
    `Message` | Message.`putCharProperty(SimpleString key, char value)` Puts a char property in this message.
    `Message` | Message.`putCharProperty(String key, char value)`
    `Message` | Message.`putDoubleProperty(SimpleString key, double value)` Puts a double property in this message.
    `Message` | Message.`putDoubleProperty(String key, double value)`
    `Message` | Message.`putFloatProperty(SimpleString key, float value)` Puts a float property in this message.
    `Message` | Message.`putFloatProperty(String key, float value)`
    `Message` | Message.`putIntProperty(SimpleString key, int value)` Puts an int property in this message.
    `Message` | Message.`putIntProperty(String key, int value)`
    `Message` | Message.`putLongProperty(SimpleString key, long value)` Puts a long property in this message.
    `Message` | Message.`putLongProperty(String key, long value)`
    `Message` | Message.`putObjectProperty(SimpleString key, Object value)` Puts an Object property in this message.
    `Message` | Message.`putObjectProperty(String key, Object value)`
    `Message` | Message.`putShortProperty(SimpleString key, short value)` Puts a short property in this message.
    `Message` | Message.`putShortProperty(String key, short value)`
    `Message` | Message.`putStringProperty(SimpleString key, SimpleString value)` Puts a SimpleString property in this message.
    `Message` | Message.`putStringProperty(String key, String value)` Puts a String property in this message.
    `Message` | Message.`setAddress(SimpleString address)` Sets the address to send this message to.
    `Message` | Message.`setDurable(boolean durable)` Sets whether this message is durable or not.
    `Message` | Message.`setExpiration(long expiration)` Sets the expiration of this message.
    `Message` | Message.`setPriority(byte priority)` Sets the message priority.
    `Message` | Message.`setTimestamp(long timestamp)` Sets the message timestamp.
    `Message` | Message.`setUserID(org.apache.activemq.artemis.utils.UUID userID)` Sets the user ID
    `Message` | Message.`writeBodyBufferBytes(byte[] bytes)` Writes the input byte array to the message body ActiveMQBuffer
    `Message` | Message.`writeBodyBufferString(String string)` Writes the input String to the message body ActiveMQBuffer

  - ### Uses of Message in org.apache.activemq.artemis.api.core.client

    Subinterfaces of Message in org.apache.activemq.artemis.api.core.client
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `ClientMessage` A ClientMessage represents a message sent and/or received by ActiveMQ Artemis.

    Methods in org.apache.activemq.artemis.api.core.client with parameters of type Message
    Modifier and Type | Method and Description
    --- | ---
    `void` | ClientProducer.`send(Message message)` Sends a message to an address.
    `void` | ClientProducer.`send(Message message, SendAcknowledgementHandler handler)` Sends a message to the specified address instead of the ClientProducer's address.
    `void` | ClientProducer.`send(SimpleString address, Message message)` Sends a message to the specified address instead of the ClientProducer's address.
    `void` | ClientProducer.`send(SimpleString address, Message message, SendAcknowledgementHandler handler)` Sends a message to the specified address instead of the ClientProducer's address.
    `void` | ClientProducer.`send(String address, Message message)` Sends a message to the specified address instead of the ClientProducer's address.
    `void` | SendAcknowledgementHandler.`sendAcknowledged(Message message)` Notifies the client that a message sent asynchronously has been received by the server.

  - ### Uses of Message in org.apache.activemq.artemis.api.core.management

    Methods in org.apache.activemq.artemis.api.core.management with parameters of type Message
    Modifier and Type | Method and Description
    --- | ---
    `static Object` | ManagementHelper.`getResult(Message message)` Returns the result of an operation invocation or an attribute value.
    `static Object[]` | ManagementHelper.`getResults(Message message)` Returns the result of an operation invocation or an attribute value.
    `static boolean` | ManagementHelper.`hasOperationSucceeded(Message message)` Returns whether the invocation of the management operation on the server resource succeeded.
    `static boolean` | ManagementHelper.`isAttributesResult(Message message)` Returns whether the JMS message corresponds to the result of a management attribute value.
    `static boolean` | ManagementHelper.`isOperationResult(Message message)` Returns whether the JMS message corresponds to the result of a management operation invocation.
    `static void` | ManagementHelper.`putAttribute(Message message, String resourceName, String attribute)` Stores a resource attribute in a message to retrieve the value from the server resource.
    `static void` | ManagementHelper.`putOperationInvocation(Message message, String resourceName, String operationName)` Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.
    `static void` | ManagementHelper.`putOperationInvocation(Message message, String resourceName, String operationName, Object... parameters)` Stores an operation invocation in a message to invoke the corresponding operation the value from the server resource.
    `static Object[]` | ManagementHelper.`retrieveOperationParameters(Message message)` Used by ActiveMQ Artemis management service.
    `static void` | ManagementHelper.`storeResult(Message message, Object result)` Used by ActiveMQ Artemis management service.

  - ### Uses of Message in org.apache.activemq.artemis.reader

    Methods in org.apache.activemq.artemis.reader with parameters of type Message
    Modifier and Type | Method and Description
    --- | ---
    `static void` | MessageUtil.`clearProperties(Message message)`
    `static String` | MessageUtil.`getJMSCorrelationID(Message message)`
    `static byte[]` | MessageUtil.`getJMSCorrelationIDAsBytes(Message message)`
    `static SimpleString` | MessageUtil.`getJMSReplyTo(Message message)`
    `static String` | MessageUtil.`getJMSType(Message message)`
    `static Set<String>` | MessageUtil.`getPropertyNames(Message message)`
    `static boolean` | MessageUtil.`propertyExists(Message message, String name)`
    `static void` | MessageUtil.`setJMSCorrelationID(Message message, String correlationID)`
    `static void` | MessageUtil.`setJMSCorrelationIDAsBytes(Message message, byte[] correlationID)`
    `static void` | MessageUtil.`setJMSReplyTo(Message message, SimpleString dest)`
    `static void` | MessageUtil.`setJMSType(Message message, String type)`

  - ### Uses of Message in org.apache.activemq.artemis.spi.core.remoting

    Methods in org.apache.activemq.artemis.spi.core.remoting with parameters of type Message
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | SessionContext.`expireMessage(ClientConsumer consumer, Message message)`
    `abstract void` | SessionContext.`sendACK(boolean individual, boolean block, ClientConsumer consumer, Message message)`

Copyright © 2015. All rights reserved.