Home » activemq-parent-5.3.1-source-release » org.apache » activemq » command » [javadoc | source]
org.apache.activemq.command
public class: ActiveMQBytesMessage [javadoc | source]
java.lang.Object
   org.apache.activemq.command.BaseCommand
      org.apache.activemq.command.Message
         org.apache.activemq.command.ActiveMQMessage
            org.apache.activemq.command.ActiveMQBytesMessage

All Implemented Interfaces:
    javax.jms.BytesMessage, Message, MarshallAware, MessageReference, Command

A BytesMessage object is used to send a message containing a stream of uninterpreted bytes. It inherits from the Message interface and adds a bytes message body. The receiver of the message supplies the interpretation of the bytes.

The BytesMessage methods are based largely on those found in java.io.DataInputStream and java.io.DataOutputStream.

This message type is for client encoding of existing message formats. If possible, one of the other self-defining message types should be used instead.

Although the JMS API allows the use of message properties with byte messages, they are typically not used, since the inclusion of properties may affect the format.

The primitive types can be written explicitly using methods for each type. They may also be written generically as objects. For instance, a call to BytesMessage.writeInt(6) is equivalent to BytesMessage.writeObject(new Integer(6)). Both forms are provided, because the explicit form is convenient for static programming, and the object form is needed when types are not known at compile time.

When the message is first created, and when clearBody is called, the body of the message is in write-only mode. After the first call to reset has been made, the message body is in read-only mode. After a message has been sent, the client that sent it can retain and modify it without affecting the message that has been sent. The same message object can be sent multiple times. When a message has been received, the provider has called reset so that the message body is in read-only mode for the client.

If clearBody is called on a message in read-only mode, the message body is cleared and the message is in write-only mode.

If a client attempts to read a message in write-only mode, a MessageNotReadableException is thrown.

If a client attempts to write a message in read-only mode, a MessageNotWriteableException is thrown.

Field Summary
public static final  byte DATA_STRUCTURE_TYPE     
protected transient  DataOutputStream dataOut     
protected transient  ByteArrayOutputStream bytesOut     
protected transient  DataInputStream dataIn     
protected transient  int length     
Fields inherited from org.apache.activemq.command.ActiveMQMessage:
DATA_STRUCTURE_TYPE,  acknowledgeCallback
Fields inherited from org.apache.activemq.command.Message:
DEFAULT_MINIMUM_MESSAGE_SIZE,  messageId,  originalDestination,  originalTransactionId,  producerId,  destination,  transactionId,  expiration,  timestamp,  arrival,  brokerInTime,  brokerOutTime,  correlationId,  replyTo,  persistent,  type,  priority,  groupID,  groupSequence,  targetConsumerId,  compressed,  userID,  content,  marshalledProperties,  dataStructure,  redeliveryCounter,  size,  properties,  readOnlyProperties,  readOnlyBody,  recievedByDFBridge,  droppable
Fields inherited from org.apache.activemq.command.BaseCommand:
commandId,  responseRequired
Method from org.apache.activemq.command.ActiveMQBytesMessage Summary:
checkWriteOnlyBody,   clearBody,   copy,   getBodyLength,   getDataStructureType,   getJMSXMimeType,   onSend,   readBoolean,   readByte,   readBytes,   readBytes,   readChar,   readDouble,   readFloat,   readInt,   readLong,   readShort,   readUTF,   readUnsignedByte,   readUnsignedShort,   reset,   setObjectProperty,   toString,   writeBoolean,   writeByte,   writeBytes,   writeBytes,   writeChar,   writeDouble,   writeFloat,   writeInt,   writeLong,   writeObject,   writeShort,   writeUTF
Methods from org.apache.activemq.command.ActiveMQMessage:
acknowledge,   checkReadOnlyBody,   checkValidObject,   clearBody,   clearProperties,   copy,   copy,   decodeString,   encodeString,   equals,   getAcknowledgeCallback,   getBooleanProperty,   getByteProperty,   getDataStructureType,   getDoubleProperty,   getFloatProperty,   getIntProperty,   getJMSCorrelationID,   getJMSCorrelationIDAsBytes,   getJMSDeliveryMode,   getJMSDestination,   getJMSExpiration,   getJMSMessageID,   getJMSPriority,   getJMSRedelivered,   getJMSReplyTo,   getJMSTimestamp,   getJMSType,   getJMSXMimeType,   getLongProperty,   getObjectProperty,   getPropertyNames,   getShortProperty,   getStringProperty,   hashCode,   onSend,   propertyExists,   setAcknowledgeCallback,   setBooleanProperty,   setBooleanProperty,   setByteProperty,   setDoubleProperty,   setFloatProperty,   setIntProperty,   setJMSCorrelationID,   setJMSCorrelationIDAsBytes,   setJMSDeliveryMode,   setJMSDestination,   setJMSExpiration,   setJMSMessageID,   setJMSMessageID,   setJMSPriority,   setJMSRedelivered,   setJMSReplyTo,   setJMSTimestamp,   setJMSType,   setLongProperty,   setObjectProperty,   setObjectProperty,   setProperties,   setShortProperty,   setStringProperty,   visit
Methods from org.apache.activemq.command.Message:
afterMarshall,   afterUnmarshall,   beforeMarshall,   beforeUnmarshall,   clearBody,   clearProperties,   copy,   copy,   decrementReferenceCount,   getArrival,   getBrokerInTime,   getBrokerOutTime,   getBrokerPath,   getCluster,   getConnection,   getContent,   getCorrelationId,   getDataStructure,   getDestination,   getExpiration,   getGroupID,   getGroupSequence,   getMarshalledProperties,   getMemoryUsage,   getMessage,   getMessageHardRef,   getMessageId,   getMinimumMessageSize,   getOriginalDestination,   getOriginalTransactionId,   getPriority,   getProducerId,   getProperties,   getProperty,   getRedeliveryCounter,   getReferenceCount,   getRegionDestination,   getReplyTo,   getSize,   getTargetConsumerId,   getTimestamp,   getTransactionId,   getType,   getUserID,   incrementRedeliveryCounter,   incrementReferenceCount,   isAdvisory,   isCompressed,   isDroppable,   isDropped,   isExpired,   isInTransaction,   isMarshallAware,   isMessage,   isPersistent,   isReadOnlyBody,   isReadOnlyProperties,   isRecievedByDFBridge,   isRedelivered,   lazyCreateProperties,   onMessageRolledBack,   setArrival,   setBrokerInTime,   setBrokerOutTime,   setBrokerPath,   setCluster,   setCompressed,   setConnection,   setContent,   setCorrelationId,   setDataStructure,   setDestination,   setDroppable,   setExpiration,   setGroupID,   setGroupSequence,   setMarshalledProperties,   setMemoryUsage,   setMessageId,   setOriginalDestination,   setOriginalTransactionId,   setPersistent,   setPriority,   setProducerId,   setProperty,   setReadOnlyBody,   setReadOnlyProperties,   setRecievedByDFBridge,   setRedelivered,   setRedeliveryCounter,   setRegionDestination,   setReplyTo,   setTargetConsumerId,   setTimestamp,   setTransactionId,   setType,   setUserID,   toString,   toString
Methods from org.apache.activemq.command.BaseCommand:
copy,   getCommandId,   getFrom,   getTo,   isBrokerInfo,   isMarshallAware,   isMessage,   isMessageAck,   isMessageDispatch,   isMessageDispatchNotification,   isResponse,   isResponseRequired,   isShutdownInfo,   isWireFormatInfo,   setCommandId,   setFrom,   setResponseRequired,   setTo,   toString,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.activemq.command.ActiveMQBytesMessage Detail:
 protected  void checkWriteOnlyBody() throws MessageNotReadableException 
 public  void clearBody() throws JMSException 
    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.

 public Message copy() 
 public long getBodyLength() throws JMSException 
    Gets the number of bytes of the message body when the message is in read-only mode. The value returned can be used to allocate a byte array. The value returned is the entire length of the message body, regardless of where the pointer for reading the message is currently located.
 public byte getDataStructureType() 
 public String getJMSXMimeType() 
 public  void onSend() throws JMSException 
 public boolean readBoolean() throws JMSException 
    Reads a boolean from the bytes message stream.
 public byte readByte() throws JMSException 
    Reads a signed 8-bit value from the bytes message stream.
 public int readBytes(byte[] value) throws JMSException 
    Reads a byte array from the bytes message stream.

    If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

    If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

 public int readBytes(byte[] value,
    int length) throws JMSException 
    Reads a portion of the bytes message stream.

    If the length of array value is less than the number of bytes remaining to be read from the stream, the array should be filled. A subsequent call reads the next increment, and so on.

    If the number of bytes remaining in the stream is less than the length of array value, the bytes should be read into the array. The return value of the total number of bytes read will be less than the length of the array, indicating that there are no more bytes left to be read from the stream. The next read of the stream returns -1.

    If length is negative, or length is greater than the length of the array value, then an IndexOutOfBoundsException is thrown. No bytes will be read from the stream for this exception case.

 public char readChar() throws JMSException 
    Reads a Unicode character value from the bytes message stream.
 public double readDouble() throws JMSException 
    Reads a double from the bytes message stream.
 public float readFloat() throws JMSException 
    Reads a float from the bytes message stream.
 public int readInt() throws JMSException 
    Reads a signed 32-bit integer from the bytes message stream.
 public long readLong() throws JMSException 
    Reads a signed 64-bit integer from the bytes message stream.
 public short readShort() throws JMSException 
    Reads a signed 16-bit number from the bytes message stream.
 public String readUTF() throws JMSException 
    Reads a string that has been encoded using a modified UTF-8 format from the bytes message stream.

    For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.

 public int readUnsignedByte() throws JMSException 
    Reads an unsigned 8-bit number from the bytes message stream.
 public int readUnsignedShort() throws JMSException 
    Reads an unsigned 16-bit number from the bytes message stream.
 public  void reset() throws JMSException 
    Puts the message body in read-only mode and repositions the stream of bytes to the beginning.
 public  void setObjectProperty(String name,
    Object value) throws JMSException 
 public String toString() 
 public  void writeBoolean(boolean value) throws JMSException 
    Writes a boolean to the bytes message stream as a 1-byte value. The value true is written as the value (byte)1; the value false is written as the value (byte)0.
 public  void writeByte(byte value) throws JMSException 
    Writes a byte to the bytes message stream as a 1-byte value.
 public  void writeBytes(byte[] value) throws JMSException 
    Writes a byte array to the bytes message stream.
 public  void writeBytes(byte[] value,
    int offset,
    int length) throws JMSException 
    Writes a portion of a byte array to the bytes message stream.
 public  void writeChar(char value) throws JMSException 
    Writes a char to the bytes message stream as a 2-byte value, high byte first.
 public  void writeDouble(double value) throws JMSException 
    Converts the double argument to a long using the doubleToLongBits method in class Double, and then writes that long value to the bytes message stream as an 8-byte quantity, high byte first.
 public  void writeFloat(float value) throws JMSException 
    Converts the float argument to an int using the floatToIntBits method in class Float, and then writes that int value to the bytes message stream as a 4-byte quantity, high byte first.
 public  void writeInt(int value) throws JMSException 
    Writes an int to the bytes message stream as four bytes, high byte first.
 public  void writeLong(long value) throws JMSException 
    Writes a long to the bytes message stream as eight bytes, high byte first.
 public  void writeObject(Object value) throws JMSException 
    Writes an object to the bytes message stream.

    This method works only for the objectified primitive object types (Integer,Double, Long  ...), String objects, and byte arrays.

 public  void writeShort(short value) throws JMSException 
    Writes a short to the bytes message stream as two bytes, high byte first.
 public  void writeUTF(String value) throws JMSException 
    Writes a string to the bytes message stream using UTF-8 encoding in a machine-independent manner.

    For more information on the UTF-8 format, see "File System Safe UCS Transformation Format (FSS_UTF)", X/Open Preliminary Specification, X/Open Company Ltd., Document Number: P316. This information also appears in ISO/IEC 10646, Annex P.