org.jboss.messaging.core.message
Interface Message

All Known Subinterfaces:
ClientMessage, ClientMessageInternal, LargeServerMessage, ServerMessage
All Known Implementing Classes:
ClientMessageImpl, JournalLargeServerMessage, MessageImpl, NullStorageLargeServerMessage, ServerMessageImpl

public interface Message

A message is a routable instance that has a payload. The payload is opaque to the messaging system.

Version:
$Revision: 3341 $ $Id: Message.java 3341 2007-11-19 14:34:57Z timfox $
Author:
Ovidiu Feodorov, Tim Fox, ClebertSuconic

Method Summary
 boolean containsProperty(SimpleString key)
           
 boolean containsProperty(java.lang.String key)
           
 void decode(MessagingBuffer buffer)
           
 void decodeBody(MessagingBuffer buffer)
           
 void decodeProperties(MessagingBuffer buffer)
           
 void encode(MessagingBuffer buffer)
           
 void encodeBody(MessagingBuffer buffer)
           
 void encodeBody(MessagingBuffer buffer, long start, int size)
           
 void encodeProperties(MessagingBuffer buffer)
           
 MessagingBuffer getBody()
           
 java.io.InputStream getBodyInputStream()
          Get the InputStream used on a message that will be sent over a producer
 int getBodySize()
           
 SimpleString getDestination()
           
 int getEncodeSize()
           
 long getExpiration()
           
 long getLargeBodySize()
           
 long getMessageID()
           
 byte getPriority()
           
 TypedProperties getProperties()
           
 int getPropertiesEncodeSize()
           
 java.lang.Object getProperty(SimpleString key)
           
 java.lang.Object getProperty(java.lang.String key)
           
 java.util.Set<SimpleString> getPropertyNames()
           
 long getTimestamp()
           
 byte getType()
           
 boolean isDurable()
           
 boolean isExpired()
           
 boolean isLargeMessage()
           
 void putBooleanProperty(SimpleString key, boolean value)
           
 void putBooleanProperty(java.lang.String key, boolean value)
           
 void putByteProperty(SimpleString key, byte value)
           
 void putByteProperty(java.lang.String key, byte value)
           
 void putBytesProperty(SimpleString key, byte[] value)
           
 void putBytesProperty(java.lang.String key, byte[] value)
           
 void putDoubleProperty(SimpleString key, double value)
           
 void putDoubleProperty(java.lang.String key, double value)
           
 void putFloatProperty(SimpleString key, float value)
           
 void putFloatProperty(java.lang.String key, float value)
           
 void putIntProperty(SimpleString key, int value)
           
 void putIntProperty(java.lang.String key, int value)
           
 void putLongProperty(SimpleString key, long value)
           
 void putLongProperty(java.lang.String key, long value)
           
 void putShortProperty(SimpleString key, short value)
           
 void putShortProperty(java.lang.String key, short value)
           
 void putStringProperty(SimpleString key, SimpleString value)
           
 void putStringProperty(java.lang.String key, java.lang.String value)
           
 void putTypedProperties(TypedProperties properties)
           
 java.lang.Object removeProperty(SimpleString key)
           
 java.lang.Object removeProperty(java.lang.String key)
           
 void setBody(MessagingBuffer body)
           
 void setBodyInputStream(java.io.InputStream stream)
          Set the InputStream used on a message that will be sent over a producer
 void setDestination(SimpleString destination)
           
 void setDurable(boolean durable)
           
 void setExpiration(long expiration)
           
 void setPriority(byte priority)
           
 void setTimestamp(long timestamp)
           
 java.util.Map<java.lang.String,java.lang.Object> toMap()
           
 

Method Detail

getMessageID

long getMessageID()

getDestination

SimpleString getDestination()

setDestination

void setDestination(SimpleString destination)

getType

byte getType()

isDurable

boolean isDurable()

setDurable

void setDurable(boolean durable)

getExpiration

long getExpiration()

isExpired

boolean isExpired()

setExpiration

void setExpiration(long expiration)

getTimestamp

long getTimestamp()

setTimestamp

void setTimestamp(long timestamp)

getPriority

byte getPriority()

setPriority

void setPriority(byte priority)

getEncodeSize

int getEncodeSize()

encode

void encode(MessagingBuffer buffer)

decode

void decode(MessagingBuffer buffer)

getPropertiesEncodeSize

int getPropertiesEncodeSize()

encodeProperties

void encodeProperties(MessagingBuffer buffer)

decodeProperties

void decodeProperties(MessagingBuffer buffer)

getBodySize

int getBodySize()

isLargeMessage

boolean isLargeMessage()

getLargeBodySize

long getLargeBodySize()

encodeBody

void encodeBody(MessagingBuffer buffer,
                long start,
                int size)

setBodyInputStream

void setBodyInputStream(java.io.InputStream stream)
Set the InputStream used on a message that will be sent over a producer


getBodyInputStream

java.io.InputStream getBodyInputStream()
Get the InputStream used on a message that will be sent over a producer


encodeBody

void encodeBody(MessagingBuffer buffer)

decodeBody

void decodeBody(MessagingBuffer buffer)

getProperties

TypedProperties getProperties()

putBooleanProperty

void putBooleanProperty(SimpleString key,
                        boolean value)

putByteProperty

void putByteProperty(SimpleString key,
                     byte value)

putBytesProperty

void putBytesProperty(SimpleString key,
                      byte[] value)

putShortProperty

void putShortProperty(SimpleString key,
                      short value)

putIntProperty

void putIntProperty(SimpleString key,
                    int value)

putLongProperty

void putLongProperty(SimpleString key,
                     long value)

putFloatProperty

void putFloatProperty(SimpleString key,
                      float value)

putDoubleProperty

void putDoubleProperty(SimpleString key,
                       double value)

putStringProperty

void putStringProperty(SimpleString key,
                       SimpleString value)

putBooleanProperty

void putBooleanProperty(java.lang.String key,
                        boolean value)

putByteProperty

void putByteProperty(java.lang.String key,
                     byte value)

putBytesProperty

void putBytesProperty(java.lang.String key,
                      byte[] value)

putShortProperty

void putShortProperty(java.lang.String key,
                      short value)

putIntProperty

void putIntProperty(java.lang.String key,
                    int value)

putLongProperty

void putLongProperty(java.lang.String key,
                     long value)

putFloatProperty

void putFloatProperty(java.lang.String key,
                      float value)

putDoubleProperty

void putDoubleProperty(java.lang.String key,
                       double value)

putStringProperty

void putStringProperty(java.lang.String key,
                       java.lang.String value)

putTypedProperties

void putTypedProperties(TypedProperties properties)

getProperty

java.lang.Object getProperty(SimpleString key)

removeProperty

java.lang.Object removeProperty(SimpleString key)

containsProperty

boolean containsProperty(SimpleString key)

getProperty

java.lang.Object getProperty(java.lang.String key)

removeProperty

java.lang.Object removeProperty(java.lang.String key)

containsProperty

boolean containsProperty(java.lang.String key)

getPropertyNames

java.util.Set<SimpleString> getPropertyNames()

toMap

java.util.Map<java.lang.String,java.lang.Object> toMap()

getBody

MessagingBuffer getBody()

setBody

void setBody(MessagingBuffer body)


Copyright © 2006 JBoss Inc. All Rights Reserved.