new class to hold message headers

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/branches/qpid.0-9@495451 13f79535-47bb-0310-9956-ffa450edef68

1 files changed, 633 insertions, 0 deletions

diff --git a/java/client/src/main/java/org/apache/qpid/client/message/MessageHeaders.java b/java/client/src/main/java/org/apache/qpid/client/message/MessageHeaders.java
new file mode 100644
index 0000000000..cb260eaf8f
--- /dev/null
+++ b/java/client/src/main/java/org/apache/qpid/client/message/MessageHeaders.java
@@ -0,0 +1,633 @@
+/*
+*
+* Licensed to the Apache Software Foundation (ASF) under one
+* or more contributor license agreements.  See the NOTICE file
+* distributed with this work for additional information
+* regarding copyright ownership.  The ASF licenses this file
+* to you under the Apache License, Version 2.0 (the
+* "License"); you may not use this file except in compliance
+* with the License.  You may obtain a copy of the License at
+*
+*   http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing,
+* software distributed under the License is distributed on an
+* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+* KIND, either express or implied.  See the License for the
+* specific language governing permissions and limitations
+* under the License.
+*
+*/
+
+package org.apache.qpid.client.message;
+
+import org.apache.log4j.Logger;
+import org.apache.mina.common.ByteBuffer;
+import org.apache.qpid.AMQPInvalidClassException;
+import org.apache.qpid.framing.FieldTable;
+import org.apache.qpid.framing.FieldTableFactory;
+
+import javax.jms.JMSException;
+import javax.jms.MessageFormatException;
+import java.util.Enumeration;
+
+public class MessageHeaders
+{
+    private static final Logger _logger = Logger.getLogger(MessageHeaders.class);
+
+    private String _contentType;
+
+    private String _encoding;
+
+    private FieldTable _jmsHeaders;
+
+    private byte _deliveryMode;
+
+    private byte _priority;
+
+    private String _correlationId;
+
+    private String _replyTo;
+
+    private long _expiration;
+
+    private String _messageId;
+
+    private long _timestamp;
+
+    private String _type;
+
+    private String _userId;
+
+    private String _appId;
+
+    private String _transactionId;
+
+    public MessageHeaders()
+    {
+    }
+
+    public String getContentTypeShortString()
+    {
+        return _contentType;
+    }
+
+    public String getContentType()
+    {
+        return _contentType == null ? null : _contentType.toString();
+    }
+
+    public void setContentType(String contentType)
+    {
+        _contentType = contentType == null ? null : new String(contentType);
+    }
+
+    public String getEncoding()
+    {
+        return _encoding == null ? null : _encoding.toString();
+    }
+
+    public void setEncoding(String encoding)
+    {
+        _encoding = encoding == null ? null : new String(encoding);
+    }
+
+    public FieldTable getJMSHeaders()
+    {
+        if (_jmsHeaders == null)
+        {
+            setJMSHeaders(FieldTableFactory.newFieldTable());
+        }
+
+        return _jmsHeaders;
+    }
+
+    public void setJMSHeaders(FieldTable headers)
+    {
+        _jmsHeaders = headers;
+    }
+
+
+    public byte getDeliveryMode()
+    {
+        return _deliveryMode;
+    }
+
+    public void setDeliveryMode(byte deliveryMode)
+    {
+        _deliveryMode = deliveryMode;
+    }
+
+    public byte getPriority()
+    {
+        return _priority;
+    }
+
+    public void setPriority(byte priority)
+    {
+        _priority = priority;
+    }
+
+    public String getCorrelationId()
+    {
+        return _correlationId == null ? null : _correlationId.toString();
+    }
+
+    public void setCorrelationId(String correlationId)
+    {
+        _correlationId = correlationId == null ? null : new String(correlationId);
+    }
+
+    public String getReplyTo()
+    {
+        return _replyTo == null ? null : _replyTo.toString();
+    }
+    
+    public void setReplyTo(String replyTo)
+    {
+        _replyTo = replyTo;
+    }
+
+    public long getExpiration()
+    {
+        return _expiration;
+    }
+
+    public void setExpiration(long expiration)
+    {
+        _expiration = expiration;
+    }
+
+
+    public String getMessageId()
+    {
+        return _messageId == null ? null : _messageId.toString();
+    }
+
+    public void setMessageId(String messageId)
+    {
+        _messageId = messageId == null ? null : new String(messageId);
+    }
+
+    public long getTimestamp()
+    {
+        return _timestamp;
+    }
+
+    public void setTimestamp(long timestamp)
+    {
+        _timestamp = timestamp;
+    }
+
+    public String getType()
+    {
+        return _type == null ? null : _type.toString();
+    }
+
+    public void setType(String type)
+    {
+        _type = type == null ? null : new String(type);
+    }
+
+    public String getUserId()
+    {
+        return _userId == null ? null : _userId.toString();
+    }
+
+    public void setUserId(String userId)
+    {
+        _userId = userId == null ? null : new String(userId);
+    }
+
+    public String getAppId()
+    {
+        return _appId == null ? null : _appId.toString();
+    }
+
+    public void setAppId(String appId)
+    {
+        _appId = appId == null ? null : new String(appId);
+    }
+
+    // MapMessage  Interface
+
+    public boolean getBoolean(String string) throws JMSException
+    {
+        Boolean b = getJMSHeaders().getBoolean(string);
+
+        if (b == null)
+        {
+            if (getJMSHeaders().containsKey(string))
+            {
+                Object str = getJMSHeaders().getObject(string);
+
+                if (str == null || !(str instanceof String))
+                {
+                    throw new MessageFormatException("getBoolean can't use " + string + " item.");
+                }
+                else
+                {
+                    return Boolean.valueOf((String) str);
+                }
+            }
+            else
+            {
+                b = Boolean.valueOf(null);
+            }
+        }
+
+        return b;
+    }
+
+    public char getCharacter(String string) throws JMSException
+    {
+        Character c = getJMSHeaders().getCharacter(string);
+
+        if (c == null)
+        {
+            if (getJMSHeaders().isNullStringValue(string))
+            {
+                throw new NullPointerException("Cannot convert null char");
+            }
+            else
+            {
+                throw new MessageFormatException("getChar can't use " + string + " item.");
+            }
+        }
+        else
+        {
+            return (char) c;
+        }
+    }
+
+    public byte[] getBytes(String string) throws JMSException
+    {
+        byte[] bs = getJMSHeaders().getBytes(string);
+
+        if (bs == null)
+        {
+            throw new MessageFormatException("getBytes can't use " + string + " item.");
+        }
+        else
+        {
+            return bs;
+        }
+    }
+
+    public byte getByte(String string) throws JMSException
+    {
+            Byte b = getJMSHeaders().getByte(string);
+            if (b == null)
+            {
+                if (getJMSHeaders().containsKey(string))
+                {
+                    Object str = getJMSHeaders().getObject(string);
+
+                    if (str == null || !(str instanceof String))
+                    {
+                        throw new MessageFormatException("getByte can't use " + string + " item.");
+                    }
+                    else
+                    {
+                        return Byte.valueOf((String) str);
+                    }
+                }
+                else
+                {
+                    b = Byte.valueOf(null);
+                }
+            }
+
+            return b;
+    }
+
+    public short getShort(String string) throws JMSException
+    {
+            Short s = getJMSHeaders().getShort(string);
+
+            if (s == null)
+            {
+                s = Short.valueOf(getByte(string));
+            }
+
+            return s;
+    }
+
+    public int getInteger(String string) throws JMSException
+    {
+            Integer i = getJMSHeaders().getInteger(string);
+
+            if (i == null)
+            {
+                i = Integer.valueOf(getShort(string));
+            }
+
+            return i;
+    }
+
+    public long getLong(String string) throws JMSException
+    {
+            Long l = getJMSHeaders().getLong(string);
+
+            if (l == null)
+            {
+                l = Long.valueOf(getInteger(string));
+            }
+
+            return l;
+    }
+
+    public float getFloat(String string) throws JMSException
+    {
+            Float f = getJMSHeaders().getFloat(string);
+
+            if (f == null)
+            {
+                if (getJMSHeaders().containsKey(string))
+                {
+                    Object str = getJMSHeaders().getObject(string);
+
+                    if (str == null || !(str instanceof String))
+                    {
+                        throw new MessageFormatException("getFloat can't use " + string + " item.");
+                    }
+                    else
+                    {
+                        return Float.valueOf((String) str);
+                    }
+                }
+                else
+                {
+                    f = Float.valueOf(null);
+                }
+
+            }
+
+            return f;
+    }
+
+    public double getDouble(String string) throws JMSException
+    {
+            Double d = getJMSHeaders().getDouble(string);
+
+            if (d == null)
+            {
+                d = Double.valueOf(getFloat(string));
+            }
+
+            return d;
+    }
+
+    public String getString(String string) throws JMSException
+    {
+        String s = getJMSHeaders().getString(string);
+
+        if (s == null)
+        {
+            if (getJMSHeaders().containsKey(string))
+            {
+                Object o = getJMSHeaders().getObject(string);
+                if (o instanceof byte[])
+                {
+                    throw new MessageFormatException("getObject couldn't find " + string + " item.");
+                }
+                else
+                {
+                    if (o == null)
+                    {
+                        return null;
+                    }
+                    else
+                    {
+                        s = String.valueOf(o);
+                    }
+                }
+            }
+        }
+
+        return s;
+    }
+
+    public Object getObject(String string) throws JMSException
+    {
+        return getJMSHeaders().getObject(string);
+    }
+
+    public void setBoolean(String string, boolean b) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setBoolean(string, b);
+    }
+
+    public void setChar(String string, char c) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setChar(string, c);
+    }
+
+    public Object setBytes(String string, byte[] bytes)
+    {
+        return getJMSHeaders().setBytes(string, bytes);
+    }
+
+    public Object setBytes(String string, byte[] bytes, int start, int length)
+    {
+        return getJMSHeaders().setBytes(string, bytes, start, length);
+    }
+
+    public void setByte(String string, byte b) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setByte(string, b);
+    }
+
+    public void setShort(String string, short i) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setShort(string, i);
+    }
+
+    public void setInteger(String string, int i) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setInteger(string, i);
+    }
+
+    public void setLong(String string, long l) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setLong(string, l);
+    }
+
+    public void setFloat(String string, float v) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setFloat(string, v);
+    }
+
+    public void setDouble(String string, double v) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setDouble(string, v);
+    }
+
+    public void setString(String string, String string1) throws JMSException
+    {
+        checkPropertyName(string);
+        getJMSHeaders().setString(string, string1);
+    }
+
+    public void setObject(String string, Object object) throws JMSException
+    {
+        checkPropertyName(string);
+        try
+        {
+            getJMSHeaders().setObject(string, object);
+        }
+        catch (AMQPInvalidClassException aice)
+        {
+            throw new MessageFormatException("Only primatives are allowed object is:" + object.getClass());
+        }
+    }
+
+    public boolean itemExists(String string) throws JMSException
+    {
+        return getJMSHeaders().containsKey(string);
+    }
+
+    public Enumeration getPropertyNames()
+    {
+        return getJMSHeaders().getPropertyNames();
+    }
+
+    public void clear()
+    {
+        getJMSHeaders().clear();
+    }
+
+    public boolean propertyExists(String propertyName)
+    {
+        return getJMSHeaders().propertyExists(propertyName);
+    }
+
+    public Object put(Object key, Object value)
+    {
+        return getJMSHeaders().setObject(key.toString(), value);
+    }
+
+    public Object remove(String propertyName)
+    {
+        return getJMSHeaders().remove(propertyName);
+    }
+
+    public boolean isEmpty()
+    {
+        return getJMSHeaders().isEmpty();
+    }
+
+    public void writeToBuffer(ByteBuffer data)
+    {
+        getJMSHeaders().writeToBuffer(data);
+    }
+
+    public Enumeration getMapNames()
+    {
+        return getPropertyNames();
+    }
+
+    protected static void checkPropertyName(CharSequence propertyName)
+    {
+        if (propertyName == null)
+        {
+            throw new IllegalArgumentException("Property name must not be null");
+        }
+        else if (propertyName.length() == 0)
+        {
+            throw new IllegalArgumentException("Property name must not be the empty string");
+        }
+
+        checkIdentiferFormat(propertyName);
+    }
+
+    protected static void checkIdentiferFormat(CharSequence propertyName)
+    {
+//        JMS requirements 3.5.1 Property Names
+//        Identifiers:
+//        - An identifier is an unlimited-length character sequence that must begin
+//          with a Java identifier start character; all following characters must be Java
+//          identifier part characters. An identifier start character is any character for
+//          which the method Character.isJavaIdentifierStart returns true. This includes
+//          '_' and '$'. An identifier part character is any character for which the
+//          method Character.isJavaIdentifierPart returns true.
+//        - Identifiers cannot be the names NULL, TRUE, or FALSE.
+//        – Identifiers cannot be NOT, AND, OR, BETWEEN, LIKE, IN, IS, or
+//          ESCAPE.
+//        – Identifiers are either header field references or property references. The
+//          type of a property value in a message selector corresponds to the type
+//          used to set the property. If a property that does not exist in a message is
+//          referenced, its value is NULL. The semantics of evaluating NULL values
+//          in a selector are described in Section 3.8.1.2, “Null Values.”
+//        – The conversions that apply to the get methods for properties do not
+//          apply when a property is used in a message selector expression. For
+//          example, suppose you set a property as a string value, as in the
+//          following:
+//              myMessage.setStringProperty("NumberOfOrders", "2");
+//          The following expression in a message selector would evaluate to false,
+//          because a string cannot be used in an arithmetic expression:
+//          "NumberOfOrders > 1"
+//        – Identifiers are case sensitive.
+//        – Message header field references are restricted to JMSDeliveryMode,
+//          JMSPriority, JMSMessageID, JMSTimestamp, JMSCorrelationID, and
+//          JMSType. JMSMessageID, JMSCorrelationID, and JMSType values may be
+//          null and if so are treated as a NULL value.
+
+        if (Boolean.getBoolean("strict-jms"))
+        {
+            // JMS start character
+            if (!(Character.isJavaIdentifierStart(propertyName.charAt(0))))
+            {
+                throw new IllegalArgumentException("Identifier '" + propertyName + "' does not start with a valid JMS identifier start character");
+            }
+
+            // JMS part character
+            int length = propertyName.length();
+            for (int c = 1; c < length; c++)
+            {
+                if (!(Character.isJavaIdentifierPart(propertyName.charAt(c))))
+                {
+                    throw new IllegalArgumentException("Identifier '" + propertyName + "' contains an invalid JMS identifier character");
+                }
+            }
+
+
+
+
+            // JMS invalid names
+            if ((propertyName.equals("NULL")
+                 || propertyName.equals("TRUE")
+                 || propertyName.equals("FALSE")
+                 || propertyName.equals("NOT")
+                 || propertyName.equals("AND")
+                 || propertyName.equals("OR")
+                 || propertyName.equals("BETWEEN")
+                 || propertyName.equals("LIKE")
+                 || propertyName.equals("IN")
+                 || propertyName.equals("IS")
+                 || propertyName.equals("ESCAPE")))
+            {
+                throw new IllegalArgumentException("Identifier '" + propertyName + "' is not allowed in JMS");
+            }
+        }
+
+    }
+
+	public String get_transactionId() {
+		return _transactionId;
+	}
+
+	public void set_transactionId(String id) {
+		_transactionId = id;
+	}
+}
+
+