org.jboss.jms
Class MessageImpl

java.lang.Object
  org.jboss.jms.MessageImpl

All Implemented Interfaces:

java.lang.Cloneable, JBossMessage (src) , Message (src) , java.io.Serializable

Direct Known Subclasses:

BytesMessageImpl (src) , MapMessageImpl (src) , ObjectMessageImpl (src) , StreamMessageImpl (src) , TextMessageImpl (src)

public class MessageImpl

extends java.lang.Object

implements JBossMessage (src) , java.lang.Cloneable, java.io.Serializable

See Also:

Serialized Form

body

protected java.lang.Object body

type

protected java.lang.String type

deliveryId

public long deliveryId

MessageImpl

public MessageImpl()

create

public static Message (src)  create(java.lang.Class type)
                      throws JMSException (src) 

Throws:

JMSException (src)

acknowledge

public void acknowledge()
                 throws JMSException (src) 

Description copied from interface: Message (src)

Acknowledges all consumed messages of the session of this consumed message.

All consumed JMS messages support the acknowledge method for use when a client has specified that its JMS session's consumed messages are to be explicitly acknowledged. By invoking acknowledge on a consumed message, a client acknowledges all messages consumed by the session that the message was delivered to.

Calls to acknowledge are ignored for both transacted sessions and sessions specified to use implicit acknowledgement modes.

A client may individually acknowledge each message as it is consumed, or it may choose to acknowledge messages as an application-defined group (which is done by calling acknowledge on the last received message of the group, thereby acknowledging all messages consumed by the session.)

Messages that have been received but not acknowledged may be redelivered.

Specified by:

acknowledge in interface Message (src)

Throws:

JMSException (src) - if the JMS provider fails to acknowledge the messages due to some internal error.

See Also:

Session.CLIENT_ACKNOWLEDGE

clearBody

public void clearBody()

Description copied from interface: Message (src)

Clears out the message body. Clearing a message's body does not clear its header values or property entries.

If this message body was read-only, calling this method leaves the message body in the same state as an empty body in a newly created message.

Specified by:

clearBody in interface Message (src)

clearProperties

public final void clearProperties()

Description copied from interface: Message (src)

Clears a message's properties.

The message's header fields and body are not cleared.

Specified by:

clearProperties in interface Message (src)

getBooleanProperty

public final boolean getBooleanProperty(java.lang.String name)
                                 throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the boolean property with the specified name.

Specified by:

getBooleanProperty in interface Message (src)

Parameters:

name - the name of the boolean property

Returns:

the boolean property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getByteProperty

public final byte getByteProperty(java.lang.String name)
                           throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the byte property with the specified name.

Specified by:

getByteProperty in interface Message (src)

Parameters:

name - the name of the byte property

Returns:

the byte property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getDoubleProperty

public final double getDoubleProperty(java.lang.String name)
                               throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the double property with the specified name.

Specified by:

getDoubleProperty in interface Message (src)

Parameters:

name - the name of the double property

Returns:

the double property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getFloatProperty

public final float getFloatProperty(java.lang.String name)
                             throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the float property with the specified name.

Specified by:

getFloatProperty in interface Message (src)

Parameters:

name - the name of the float property

Returns:

the float property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getIntProperty

public final int getIntProperty(java.lang.String name)
                         throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the int property with the specified name.

Specified by:

getIntProperty in interface Message (src)

Parameters:

name - the name of the int property

Returns:

the int property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getJMSCorrelationID

public final java.lang.String getJMSCorrelationID()

Description copied from interface: Message (src)

Gets the correlation ID for the message.

This method is used to return correlation ID values that are either provider-specific message IDs or application-specific String values.

Specified by:

getJMSCorrelationID in interface Message (src)

Returns:

the correlation ID of a message as a String

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationIDAsBytes(), Message.setJMSCorrelationIDAsBytes(byte[])

getJMSCorrelationIDAsBytes

public final byte[] getJMSCorrelationIDAsBytes()

Description copied from interface: Message (src)

Gets the correlation ID as an array of bytes for the message.

The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

getJMSCorrelationIDAsBytes in interface Message (src)

Returns:

the correlation ID of a message as an array of bytes

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationID(), Message.setJMSCorrelationIDAsBytes(byte[])

getJMSDeliveryMode

public final int getJMSDeliveryMode()

Description copied from interface: Message (src)

Gets the DeliveryMode value specified for this message.

Specified by:

getJMSDeliveryMode in interface Message (src)

Returns:

the delivery mode for this message

See Also:

Message.setJMSDeliveryMode(int), DeliveryMode (src)

getJMSDestination

public final Destination (src)  getJMSDestination()

Description copied from interface: Message (src)

Gets the Destination object for this message.

The JMSDestination header field contains the destination to which the message is being sent.

When a message is sent, this field is ignored. After completion of the send or publish method, the field holds the destination specified by the method.

When a message is received, its JMSDestination value must be equivalent to the value assigned when it was sent.

Specified by:

getJMSDestination in interface Message (src)

Returns:

the destination of this message

See Also:

Message.setJMSDestination(Destination)

getJMSExpiration

public final long getJMSExpiration()

Description copied from interface: Message (src)

Gets the message's expiration value.

When a message is sent, the JMSExpiration header field is left unassigned. After completion of the send or publish method, it holds the expiration time of the message. This is the sum of the time-to-live value specified by the client and the GMT at the time of the send or publish.

If the time-to-live is specified as zero, JMSExpiration is set to zero to indicate that the message does not expire.

When a message's expiration time is reached, a provider should discard it. The JMS API does not define any form of notification of message expiration.

Clients should not receive messages that have expired; however, the JMS API does not guarantee that this will not happen.

Specified by:

getJMSExpiration in interface Message (src)

Returns:

the time the message expires, which is the sum of the time-to-live value specified by the client and the GMT at the time of the send

See Also:

Message.setJMSExpiration(long)

getJMSMessageID

public final java.lang.String getJMSMessageID()

Description copied from interface: Message (src)

Gets the message ID.

The JMSMessageID header field contains a value that uniquely identifies each message sent by a provider.

When a message is sent, JMSMessageID can be ignored. When the send or publish method returns, it contains a provider-assigned value.

A JMSMessageID is a String value that should function as a unique key for identifying messages in a historical repository. The exact scope of uniqueness is provider-defined. It should at least cover all messages for a specific installation of a provider, where an installation is some connected set of message routers.

All JMSMessageID values must start with the prefix 'ID:'. Uniqueness of message ID values across different providers is not required.

Since message IDs take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the message ID is not used by an application. By calling the MessageProducer.setDisableMessageID method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the message ID set to null; if the provider ignores the hint, the message ID must be set to its normal unique value.

Specified by:

getJMSMessageID in interface Message (src)

Returns:

the message ID

See Also:

Message.setJMSMessageID(String), MessageProducer.setDisableMessageID(boolean)

getJMSPriority

public final int getJMSPriority()

Description copied from interface: Message (src)

Gets the message priority level.

The JMS API defines ten levels of priority value, with 0 as the lowest priority and 9 as the highest. In addition, clients should consider priorities 0-4 as gradations of normal priority and priorities 5-9 as gradations of expedited priority.

The JMS API does not require that a provider strictly implement priority ordering of messages; however, it should do its best to deliver expedited messages ahead of normal messages.

Specified by:

getJMSPriority in interface Message (src)

Returns:

the default message priority

See Also:

Message.setJMSPriority(int)

getJMSRedelivered

public final boolean getJMSRedelivered()

Description copied from interface: Message (src)

Gets an indication of whether this message is being redelivered.

If a client receives a message with the JMSRedelivered field set, it is likely, but not guaranteed, that this message was delivered earlier but that its receipt was not acknowledged at that time.

Specified by:

getJMSRedelivered in interface Message (src)

Returns:

true if this message is being redelivered

See Also:

Message.setJMSRedelivered(boolean)

getJMSReplyTo

public final Destination (src)  getJMSReplyTo()

Description copied from interface: Message (src)

Gets the Destination object to which a reply to this message should be sent.

Specified by:

getJMSReplyTo in interface Message (src)

Returns:

Destination to which to send a response to this message

See Also:

Message.setJMSReplyTo(Destination)

getJMSTimestamp

public final long getJMSTimestamp()

Description copied from interface: Message (src)

Gets the message timestamp.

The JMSTimestamp header field contains the time a message was handed off to a provider to be sent. It is not the time the message was actually transmitted, because the actual send may occur later due to transactions or other client-side queueing of messages.

When a message is sent, JMSTimestamp is ignored. When the send or publish method returns, it contains a time value somewhere in the interval between the call and the return. The value is in the format of a normal millis time value in the Java programming language.

Since timestamps take some effort to create and increase a message's size, some JMS providers may be able to optimize message overhead if they are given a hint that the timestamp is not used by an application. By calling the MessageProducer.setDisableMessageTimestamp method, a JMS client enables this potential optimization for all messages sent by that message producer. If the JMS provider accepts this hint, these messages must have the timestamp set to zero; if the provider ignores the hint, the timestamp must be set to its normal value.

Specified by:

getJMSTimestamp in interface Message (src)

Returns:

the message timestamp

See Also:

Message.setJMSTimestamp(long), MessageProducer.setDisableMessageTimestamp(boolean)

getJMSType

public final java.lang.String getJMSType()

Description copied from interface: Message (src)

Gets the message type identifier supplied by the client when the message was sent.

Specified by:

getJMSType in interface Message (src)

Returns:

the message type

See Also:

Message.setJMSType(String)

getLongProperty

public final long getLongProperty(java.lang.String name)
                           throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the long property with the specified name.

Specified by:

getLongProperty in interface Message (src)

Parameters:

name - the name of the long property

Returns:

the long property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getObjectProperty

public final java.lang.Object getObjectProperty(java.lang.String name)
                                         throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the Java object property with the specified name.

This method can be used to return, in objectified format, an object that has been stored as a property in the message with the equivalent setObjectProperty method call, or its equivalent primitive settypeProperty method.

Specified by:

getObjectProperty in interface Message (src)

Parameters:

name - the name of the Java object property

Returns:

the Java object property value with the specified name, in objectified format (for example, if the property was set as an int, an Integer is returned); if there is no property by this name, a null value is returned

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getPropertyNames

public final java.util.Enumeration getPropertyNames()
                                             throws JMSException (src) 

Description copied from interface: Message (src)

Returns an Enumeration of all the property names.

Note that JMS standard header fields are not considered properties and are not returned in this enumeration.

Specified by:

getPropertyNames in interface Message (src)

Returns:

an enumeration of all the names of property values

Throws:

JMSException (src) - if the JMS provider fails to get the property names due to some internal error.

getShortProperty

public final short getShortProperty(java.lang.String name)
                             throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the short property with the specified name.

Specified by:

getShortProperty in interface Message (src)

Parameters:

name - the name of the short property

Returns:

the short property value for the specified name

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

getStringProperty

public final java.lang.String getStringProperty(java.lang.String name)
                                         throws JMSException (src) 

Description copied from interface: Message (src)

Returns the value of the String property with the specified name.

Specified by:

getStringProperty in interface Message (src)

Parameters:

name - the name of the String property

Returns:

the String property value for the specified name; if there is no property by this name, a null value is returned

Throws:

JMSException (src) - if the JMS provider fails to get the property value due to some internal error.

isReadOnly

public final boolean isReadOnly()

hasExpired

public final boolean hasExpired()

setSession

public final void setSession(P2PSessionDelegate (src)  session)

setDeliveryId

public final void setDeliveryId(long id)

setOriginClientID

public final void setOriginClientID(java.lang.String clientId)

getOrigianClientID

public final java.lang.String getOrigianClientID()

setIsLocal

public final void setIsLocal(boolean value)

isLocal

public boolean isLocal()

propertyExists

public final boolean propertyExists(java.lang.String name)

Description copied from interface: Message (src)

Indicates whether a property value exists.

Specified by:

propertyExists in interface Message (src)

Parameters:

name - the name of the property to test

Returns:

true if the property exists

setBooleanProperty

public final void setBooleanProperty(java.lang.String name,
                                     boolean value)
                              throws JMSException (src) 

Description copied from interface: Message (src)

Sets a boolean property value with the specified name into the message.

Specified by:

setBooleanProperty in interface Message (src)

Parameters:

name - the name of the boolean property

value - the boolean property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setByteProperty

public final void setByteProperty(java.lang.String name,
                                  byte value)
                           throws JMSException (src) 

Description copied from interface: Message (src)

Sets a byte property value with the specified name into the message.

Specified by:

setByteProperty in interface Message (src)

Parameters:

name - the name of the byte property

value - the byte property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setDoubleProperty

public final void setDoubleProperty(java.lang.String name,
                                    double value)
                             throws JMSException (src) 

Description copied from interface: Message (src)

Sets a double property value with the specified name into the message.

Specified by:

setDoubleProperty in interface Message (src)

Parameters:

name - the name of the double property

value - the double property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setFloatProperty

public final void setFloatProperty(java.lang.String name,
                                   float value)
                            throws JMSException (src) 

Description copied from interface: Message (src)

Sets a float property value with the specified name into the message.

Specified by:

setFloatProperty in interface Message (src)

Parameters:

name - the name of the float property

value - the float property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setIntProperty

public final void setIntProperty(java.lang.String name,
                                 int value)
                          throws JMSException (src) 

Description copied from interface: Message (src)

Sets an int property value with the specified name into the message.

Specified by:

setIntProperty in interface Message (src)

Parameters:

name - the name of the int property

value - the int property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setJMSCorrelationID

public final void setJMSCorrelationID(java.lang.String correlationID)

Description copied from interface: Message (src)

Sets the correlation ID for the message.

A client can use the JMSCorrelationID header field to link one message with another. A typical use is to link a response message with its request message.

JMSCorrelationID can hold one of the following:

• A provider-specific message ID
• An application-specific String
• A provider-native byte[] value

Since each message sent by a JMS provider is assigned a message ID value, it is convenient to link messages via message ID. All message ID values must start with the 'ID:' prefix.

In some cases, an application (made up of several clients) needs to use an application-specific value for linking messages. For instance, an application may use JMSCorrelationID to hold a value referencing some external information. Application-specified values must not start with the 'ID:' prefix; this is reserved for provider-generated message ID values.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by clients that do not use the JMS API. A byte[] value is used for this purpose. JMS providers without native correlation ID values are not required to support byte[] values. The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

setJMSCorrelationID in interface Message (src)

Parameters:

correlationID - the message ID of a message being referred to

See Also:

Message.getJMSCorrelationID(), Message.getJMSCorrelationIDAsBytes(), Message.setJMSCorrelationIDAsBytes(byte[])

setJMSCorrelationIDAsBytes

public final void setJMSCorrelationIDAsBytes(byte[] correlationID)

Description copied from interface: Message (src)

Sets the correlation ID as an array of bytes for the message.

The array is copied before the method returns, so future modifications to the array will not alter this message header.

If a provider supports the native concept of correlation ID, a JMS client may need to assign specific JMSCorrelationID values to match those expected by native messaging clients. JMS providers without native correlation ID values are not required to support this method and its corresponding get method; their implementation may throw a java.lang.UnsupportedOperationException.

The use of a byte[] value for JMSCorrelationID is non-portable.

Specified by:

setJMSCorrelationIDAsBytes in interface Message (src)

Parameters:

correlationID - the correlation ID value as an array of bytes

See Also:

Message.setJMSCorrelationID(String), Message.getJMSCorrelationID(), Message.getJMSCorrelationIDAsBytes()

setJMSDeliveryMode

public final void setJMSDeliveryMode(int deliveryMode)

Description copied from interface: Message (src)

Sets the DeliveryMode value for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSDeliveryMode in interface Message (src)

Parameters:

deliveryMode - the delivery mode for this message

See Also:

Message.getJMSDeliveryMode(), DeliveryMode (src)

setJMSDestination

public final void setJMSDestination(Destination (src)  destination)

Description copied from interface: Message (src)

Sets the Destination object for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSDestination in interface Message (src)

Parameters:

destination - the destination for this message

See Also:

Message.getJMSDestination()

setJMSExpiration

public final void setJMSExpiration(long expiration)

Description copied from interface: Message (src)

Sets the message's expiration value.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSExpiration in interface Message (src)

Parameters:

expiration - the message's expiration time

See Also:

Message.getJMSExpiration()

setJMSMessageID

public final void setJMSMessageID(java.lang.String messageID)

Description copied from interface: Message (src)

Sets the message ID.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSMessageID in interface Message (src)

Parameters:

messageID - the ID of the message

See Also:

Message.getJMSMessageID()

setJMSPriority

public final void setJMSPriority(int priority)

Description copied from interface: Message (src)

Sets the priority level for this message.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSPriority in interface Message (src)

Parameters:

priority - the priority of this message

See Also:

Message.getJMSPriority()

setJMSRedelivered

public final void setJMSRedelivered(boolean redelivered)

Description copied from interface: Message (src)

Specifies whether this message is being redelivered.

This field is set at the time the message is delivered. This method can be used to change the value for a message that has been received.

Specified by:

setJMSRedelivered in interface Message (src)

Parameters:

redelivered - an indication of whether this message is being redelivered

See Also:

Message.getJMSRedelivered()

setJMSReplyTo

public final void setJMSReplyTo(Destination (src)  replyTo)

Description copied from interface: Message (src)

Sets the Destination object to which a reply to this message should be sent.

The JMSReplyTo header field contains the destination where a reply to the current message should be sent. If it is null, no reply is expected. The destination may be either a Queue object or a Topic object.

Messages sent with a null JMSReplyTo value may be a notification of some event, or they may just be some data the sender thinks is of interest.

Messages with a JMSReplyTo value typically expect a response. A response is optional; it is up to the client to decide. These messages are called requests. A message sent in response to a request is called a reply.

In some cases a client may wish to match a request it sent earlier with a reply it has just received. The client can use the JMSCorrelationID header field for this purpose.

Specified by:

setJMSReplyTo in interface Message (src)

Parameters:

replyTo - Destination to which to send a response to this message

See Also:

Message.getJMSReplyTo()

setJMSTimestamp

public final void setJMSTimestamp(long timestamp)

Description copied from interface: Message (src)

Sets the message timestamp.

JMS providers set this field when a message is sent. This method can be used to change the value for a message that has been received.

Specified by:

setJMSTimestamp in interface Message (src)

Parameters:

timestamp - the timestamp for this message

See Also:

Message.getJMSTimestamp()

setJMSType

public final void setJMSType(java.lang.String type)

Description copied from interface: Message (src)

Sets the message type.

Some JMS providers use a message repository that contains the definitions of messages sent by applications. The JMSType header field may reference a message's definition in the provider's repository.

The JMS API does not define a standard message definition repository, nor does it define a naming policy for the definitions it contains.

Some messaging systems require that a message type definition for each application message be created and that each message specify its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType, whether the application makes use of it or not. This ensures that the field is properly set for those providers that require it.

To ensure portability, JMS clients should use symbolic values for JMSType that can be configured at installation time to the values defined in the current provider's message repository. If string literals are used, they may not be valid type names for some JMS providers.

Specified by:

setJMSType in interface Message (src)

Parameters:

type - the message type

See Also:

Message.getJMSType()

setLongProperty

public final void setLongProperty(java.lang.String name,
                                  long value)
                           throws JMSException (src) 

Description copied from interface: Message (src)

Sets a long property value with the specified name into the message.

Specified by:

setLongProperty in interface Message (src)

Parameters:

name - the name of the long property

value - the long property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setObjectProperty

public final void setObjectProperty(java.lang.String name,
                                    java.lang.Object value)
                             throws JMSException (src) 

Description copied from interface: Message (src)

Sets a Java object property value with the specified name into the message.

Note that this method works only for the objectified primitive object types (Integer, Double, Long ...) and String objects.

Specified by:

setObjectProperty in interface Message (src)

Parameters:

name - the name of the Java object property

value - the Java object property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setReadOnly

public final void setReadOnly(boolean value)

setShortProperty

public final void setShortProperty(java.lang.String name,
                                   short value)
                            throws JMSException (src) 

Description copied from interface: Message (src)

Sets a short property value with the specified name into the message.

Specified by:

setShortProperty in interface Message (src)

Parameters:

name - the name of the short property

value - the short property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

setStringProperty

public final void setStringProperty(java.lang.String name,
                                    java.lang.String value)
                             throws JMSException (src) 

Description copied from interface: Message (src)

Sets a String property value with the specified name into the message.

Specified by:

setStringProperty in interface Message (src)

Parameters:

name - the name of the String property

value - the String property value to set

Throws:

JMSException (src) - if the JMS provider fails to set the property due to some internal error.

generateMessageID

public void generateMessageID()
                       throws JMSException (src) 

Description copied from interface: JBossMessage (src)

Generate a message id for the message

Specified by:

generateMessageID in interface JBossMessage (src)

Throws:

JMSException (src)

generateTimestamp

public void generateTimestamp()
                       throws JMSException (src) 

Description copied from interface: JBossMessage (src)

Generate a timestamp for the message

Specified by:

generateTimestamp in interface JBossMessage (src)

Throws:

JMSException (src)

getSessionDelegate

public SessionDelegate (src)  getSessionDelegate()
                                   throws JMSException (src) 

Description copied from interface: JBossMessage (src)

Retrieve the session for this message

Specified by:

getSessionDelegate in interface JBossMessage (src)

Returns:

the session delegate

Throws:

JMSException (src) - for any error

makeReadOnly

public void makeReadOnly()

Description copied from interface: JBossMessage (src)

Change the message to read only

Specified by:

makeReadOnly in interface JBossMessage (src)

clone

public java.lang.Object clone()

Specified by:

clone in interface JBossMessage (src)

throwExceptionIfReadOnly

protected void throwExceptionIfReadOnly()
                                 throws MessageNotWriteableException (src) 

Throws:

MessageNotWriteableException (src)