mq5.0-source.main.mq-jmsra.jmsra-ra.src.main.java.com.sun.messaging.jms.ra.DirectMapPacket Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2000-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.messaging.jms.ra;
import java.io.IOException;
import java.io.EOFException;
import javax.jms.JMSException;
import javax.jms.MessageFormatException;
//import java.io.DataInputStream;
//import java.io.DataOutputStream;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.util.HashMap;
import java.util.Enumeration;
import java.util.Collections;
import java.util.Map;
import com.sun.messaging.jmq.io.PacketType;
//import com.sun.messaging.jmq.io.JMQByteArrayOutputStream;
import com.sun.messaging.jmq.io.JMSPacket;
import com.sun.messaging.jmq.jmsservice.JMSService;
/**
* A MapMessage object is used to send a set of name-value pairs.
* The names are String objects, and the values are primitive
* data types in the Java programming language. The names must have a value
* that is not null, and not an empty string. The entries can be accessed
* sequentially or randomly by name. The order of the entries is undefined.
* MapMessage inherits from the Message interface
* and adds a message body that contains a Map.
*
* The primitive types can be read or written explicitly using methods
* for each type. They may also be read or written generically as objects.
* For instance, a call to MapMessage.setInt("foo", 6) is
* equivalent to MapMessage.setObject("foo", 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 a client receives a MapMessage, it is in read-only
* mode. If a client attempts to write to the message at this point, a
* MessageNotWriteableException is thrown. If
* clearBody is called, the message can now be both read from and
* written to.
*
*
MapMessage objects support the following conversion table.
* The marked cases must be supported. The unmarked cases must throw a
* JMSException. The String-to-primitive conversions
* may throw a runtime exception if the primitive's valueOf()
* method does not accept it as a valid String representation of
* the primitive.
*
*
A value written as the row type can be read as the column type.
*
*
* | | boolean byte short char int long float double String byte[]
* |----------------------------------------------------------------------
* |boolean | X X
* |byte | X X X X X
* |short | X X X X
* |char | X X
* |int | X X X
* |long | X X
* |float | X X X
* |double | X X
* |String | X X X X X X X X
* |byte[] | X
* |----------------------------------------------------------------------
*
*
* Attempting to read a null value as a primitive type must be treated
* as calling the primitive's corresponding valueOf(String)
* conversion method with a null value. Since char does not
* support a String conversion, attempting to read a null value
* as a char must throw a NullPointerException.
*
* @see javax.jms.Session#createMapMessage()
* @see javax.jms.BytesMessage
* @see javax.jms.Message
* @see javax.jms.ObjectMessage
* @see javax.jms.StreamMessage
* @see javax.jms.TextMessage
*/
public class DirectMapPacket
extends DirectPacket
implements javax.jms.MapMessage {
private Map map = new HashMap();
private byte[] messageBody = null;
private ByteArrayOutputStream byteArrayOutputStream = null;
private ObjectOutputStream objectOutputStream = null;
private ByteArrayInputStream byteArrayInputStream = null;
private ObjectInputStream objectInputStream = null;
/**
* Logging
*/
private static transient final String _className =
"com.sun.messaging.jms.ra.DirectMapPacket";
/**
* Create a new instance of DirectMapPacket.
*
* Used by the createMapMessage API.
*/
public DirectMapPacket(DirectSession ds, JMSService jmsservice)
throws JMSException {
super(ds, jmsservice);
if (_logFINE){
Object params[] = new Object[2];
params[0] = ds;
params[1] = jmsservice;
_loggerOC.entering(_className, "constructor()", params);
}
}
/**
* Create a new instance of DirectMapPacket.
* Used by Consumer.deliver.
*/
public DirectMapPacket(JMSPacket jmsPacket, long consumerId,
DirectSession ds, JMSService jmsservice)
throws JMSException {
super(jmsPacket, consumerId, ds, jmsservice);
this._getMessageBodyFromPacket();
}
/////////////////////////////////////////////////////////////////////////
// methods that implement javax.jms.MapMessage
/////////////////////////////////////////////////////////////////////////
/**
* Clear out the message body.
*/
public void clearBody()
throws JMSException {
super.clearBody();
this.map.clear();
}
/**
* Return the boolean value with the specified name.
*
* @param name The name of the boolean
*
* @return The boolean value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public boolean getBoolean(String name)
throws JMSException {
return ConvertValue.toBoolean(this.map.get(name));
}
/**
* Return the byte value with the specified name.
*
* @param name The name of the byte
*
* @return The byte value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public byte getByte(String name)
throws JMSException {
return ConvertValue.toByte(this.map.get(name));
}
/**
* Return the byte array value with the specified name.
*
* @param name The name of the byte array
*
* @return a copy of the byte array value with the specified name; if there
* is no item by this name, a null value is returned.
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public byte[] getBytes(String name)
throws JMSException {
Object obj = this.map.get(name);
if (obj == null) {
return null;
} else {
if (obj instanceof byte[]) {
return (byte[])obj;
} else {
String errMsg = _lgrMID_EXC +
":MapMessage:getBytes[]:Key="+name+
":cannot be rea as a byte array.";
_loggerJM.severe(errMsg);
MessageFormatException mfe = new MessageFormatException(errMsg);
throw mfe;
}
}
}
/**
* Return the Unicode character value with the specified name.
*
* @param name The name of the Unicode character
*
* @return the Unicode character value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public char getChar(String name)
throws JMSException {
return ConvertValue.toChar(this.map.get(name));
}
/**
* Return the double value with the specified name.
*
* @param name The name of the double
*
* @return The double value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public double getDouble(String name)
throws JMSException {
return ConvertValue.toDouble(this.map.get(name));
}
/**
* Return the float value with the specified name.
*
* @param name The name of the float
*
* @return The float value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public float getFloat(String name)
throws JMSException {
return ConvertValue.toFloat(this.map.get(name));
}
/**
* Returns the int value with the specified name.
*
* @param name The name of the int
*
* @return The int value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public int getInt(String name)
throws JMSException {
return ConvertValue.toInt(this.map.get(name));
}
/**
* Return the long value with the specified name.
*
* @param name The name of the long
*
* @return The long value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public long getLong(String name)
throws JMSException {
return ConvertValue.toLong(this.map.get(name));
}
/**
* Return an Enumeration of all the names in the
* MapMessage object.
*
* @return an enumeration of all the names in this MapMessage
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
*/
public Enumeration getMapNames()
throws JMSException {
return Collections.enumeration(this.map.keySet());
}
/**
* Return the value of the object with the specified name.
*
*
This method can be used to return, in objectified format,
* an object in the Java programming language ("Java object") that had
* been stored in the Map with the equivalent
* setObject method call, or its equivalent primitive
* settype method.
*
*
Note that byte values are returned as byte[], not
* Byte[].
*
* @param name the name of the Java object
*
* @return a copy of the Java object value with the specified name, in
* objectified format (for example, if the object was set as an
* int, an Integer is returned); if there is no
* item by this name, a null value is returned
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
*/
public Object getObject(String name)
throws JMSException {
return this.map.get(name);
}
/**
* Return the short value with the specified name.
*
* @param name The name of the short
*
* @return The short value with the specified name
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public short getShort(String name)
throws JMSException {
return ConvertValue.toShort(this.map.get(name));
}
/**
* Return the String value with the specified name.
*
* @param name The name of the String
*
* @return The String value with the specified name; if there
* is no item by this name, a null value is returned
*
* @throws JMSException if the JMS provider fails to read the message
* due to some internal error.
* @throws MessageFormatException if this type conversion is invalid.
*/
public String getString(String name)
throws JMSException {
return ConvertValue.toString(this.map.get(name));
}
/**
* Indicate whether an item exists in this MapMessage object.
*
* @param name The name of the item to test
*
* @return true If the item exists
*
* @throws JMSException if the JMS provider fails to determine if the
* item exists due to some internal error.
*/
public boolean itemExists(String name)
throws JMSException {
return this.map.containsKey(name);
}
/**
* Set a boolean value with the specified name into the Map.
*
* @param name The name of the boolean
* @param value The boolean value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setBoolean(String name, boolean value)
throws JMSException {
String methodName = "setBoolean()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a byte value with the specified name into the Map.
*
* @param name The name of the byte
* @param value The byte value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setByte(String name, byte value)
throws JMSException {
String methodName = "setByte()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a byte array value with the specified name into the Map.
*
* @param name the name of the byte array
* @param value the byte array value to set in the Map; the array
* is copied so that the value for name will
* not be altered by future modifications
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws NullPointerException if the name is null, or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setBytes(String name, byte[] value)
throws JMSException {
String methodName = "setBytes(byte[])";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a portion of the byte array value with the specified name into the
* Map.
*
* @param name The name of the byte array
* @param value The byte array value to set in the Map
* @param offset The initial offset within the byte array
* @param length The number of bytes to use
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setBytes(String name, byte[] value, int offset, int length)
throws JMSException {
String methodName = "setBytes(byte[], offset, length)";
this._checkValidKeyAndReadOnlyBody(methodName, name);
byte[] dest = new byte[length];
System.arraycopy(value, offset, dest, 0, length);
this.map.put(name, dest);
}
/**
* Set a Unicode character value with the specified name into the Map.
*
* @param name The name of the Unicode character
* @param value The Unicode character value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setChar(String name, char value)
throws JMSException {
String methodName = "setChar()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a double value with the specified name into the Map.
*
* @param name The name of the double
* @param value The double value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setDouble(String name, double value)
throws JMSException {
String methodName = "setDouble()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a float value with the specified name into the Map.
*
* @param name The name of the float
* @param value The float value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setFloat(String name, float value)
throws JMSException {
String methodName = "setFloat()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set an int value with the specified name into the Map.
*
* @param name The name of the int
* @param value The int value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setInt(String name, int value)
throws JMSException {
String methodName = "setInt()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a long value with the specified name into the Map.
*
* @param name The name of the long
* @param value The long value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setLong(String name, long value)
throws JMSException {
String methodName = "setLong()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set an object value with the specified name into the Map.
*
*
This method works only for the objectified primitive
* object types (Integer, Double,
* Long ...), String objects, and byte
* arrays.
*
* @param name The name of the Java object
* @param value The Java object value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageFormatException if the object is invalid.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setObject(String name, Object value)
throws JMSException {
String methodName = "setLong()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this._checkValidObjectType(value, name);
this.map.put(name, value);
}
/**
* Set a short value with the specified name into the Map.
*
* @param name The name of the short
* @param value The short value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setShort(String name, short value)
throws JMSException {
String methodName = "setShort()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/**
* Set a String value with the specified name into the Map.
*
* @param name The name of the String
* @param value The String value to set in the Map
*
* @throws JMSException if the JMS provider fails to write the message
* due to some internal error.
* @throws IllegalArgumentException if the name is null or if the name is
* an empty string.
* @throws MessageNotWriteableException if the message is in read-only
* mode.
*/
public void setString(String name, String value)
throws JMSException {
String methodName = "setString()";
this._checkValidKeyAndReadOnlyBody(methodName, name);
this.map.put(name, value);
}
/////////////////////////////////////////////////////////////////////////
// end javax.jms.MapMessage
/////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////
// MQ methods DirectMapPacket / javax.jms.MapMessage
/////////////////////////////////////////////////////////////////////////
/**
* Set the JMS default values on this JMS MapMessage
*/
protected void _setDefaultValues()
throws JMSException {
super._setDefaultValues();
this.pkt.setPacketType(PacketType.MAP_MESSAGE);
}
/**
* Set the JMS Message body into the packet
*/
protected void _setBodyToPacket()
throws JMSException {
try {
this.byteArrayOutputStream = new ByteArrayOutputStream();
this.objectOutputStream = new ObjectOutputStream(byteArrayOutputStream);
this.objectOutputStream.writeObject(map);
this.objectOutputStream.flush();
this.messageBody = byteArrayOutputStream.toByteArray();
this.objectOutputStream.close();
this.byteArrayOutputStream.close();
super._setMessageBodyOfPacket(this.messageBody);
} catch (Exception ex) {
String errMsg = _lgrMID_EXC +
":MapMessage:Exception setting MapMessage body on send:"+
ex.getMessage();
_loggerJM.severe(errMsg);
JMSException jmse = new javax.jms.JMSException(errMsg);
jmse.initCause(ex);
throw jmse;
}
}
/**
* Get the message body from the packet
*/
protected void _getMessageBodyFromPacket()
throws JMSException {
try {
this.messageBody = super._getMessageBodyByteArray();
this.byteArrayInputStream = new ByteArrayInputStream(messageBody);
this.objectInputStream = new ObjectInputStream (byteArrayInputStream);
this.map = (Map)objectInputStream.readObject();
} catch (Exception e) {
String errMsg = _lgrMID_EXC +
":MapMessage:Exception deserializing on deliver:"+
e.getMessage();
_loggerJM.severe(errMsg);
JMSException jmse = new javax.jms.JMSException(errMsg);
jmse.initCause(e);
throw jmse;
}
}
private void _checkValidKeyAndReadOnlyBody(String methodName, String key)
throws IllegalArgumentException, JMSException {
this.checkForReadOnlyMessageBody(methodName);
if (key == null || "".equals(key)){
throw new IllegalArgumentException(
"MapMessage:" + methodName +
":name parameter is not allowed to be NULL or empty");
}
}
private void _checkValidObjectType(Object value, String name)
throws MessageFormatException {
if ((value != null) && (
value instanceof Boolean ||
value instanceof Byte ||
value instanceof Short ||
value instanceof Character||
value instanceof Integer ||
value instanceof Long ||
value instanceof Float ||
value instanceof Double ||
value instanceof String ||
value instanceof byte[]
)) {
//valid
} else {
String errMsg = _lgrMID_EXC +
":MapMessage:setObject():Invalid type" +
":name="+name+
":type="+
(value == null
? "NULL"
: value.getClass().getName());
_loggerJM.severe(errMsg);
MessageFormatException mfe = new MessageFormatException(errMsg);
throw mfe;
}
}
}