001/**
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.activemq.network.jms;
018
019import javax.jms.Connection;
020import javax.jms.Destination;
021import javax.jms.JMSException;
022import javax.jms.Message;
023
024/**
025 * Converts Message from one JMS to another
026 */
027public interface JmsMesageConvertor {
028
029    /**
030     * Convert a foreign JMS Message to a native ActiveMQ Message
031     *
032     * @param message
033     *      The target message to convert to a native ActiveMQ message
034     *
035     * @return the converted message
036     * @throws JMSException
037     */
038    Message convert(Message message) throws JMSException;
039
040    /**
041     * Convert a foreign JMS Message to a native ActiveMQ Message - Inbound or
042     * visa-versa outbound.  If the replyTo Destination instance is not null
043     * then the Message is configured with the given replyTo value.
044     *
045     * @param message
046     *      The target message to convert to a native ActiveMQ message
047     * @param replyTo
048     *      The replyTo Destination to set on the converted Message.
049     *
050     * @return the converted message
051     * @throws JMSException
052     */
053    Message convert(Message message, Destination replyTo) throws JMSException;
054
055    void setConnection(Connection connection);
056
057}