001    /**
002     *
003     * Copyright 2005 LogicBlaze, Inc.
004     *
005     * Licensed under the Apache License, Version 2.0 (the "License");
006     * you may not use this file except in compliance with the License.
007     * 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     *
017     **/
018    package org.logicblaze.lingo.jms.marshall;
019    
020    import org.logicblaze.lingo.LingoInvocation;
021    import org.logicblaze.lingo.jms.Requestor;
022    import org.springframework.remoting.support.RemoteInvocation;
023    import org.springframework.remoting.support.RemoteInvocationResult;
024    
025    import javax.jms.JMSException;
026    import javax.jms.Message;
027    
028    /**
029     * @version $Revision: 1.1 $
030     */
031    public interface Marshaller {
032        /**
033         * Creates the request message
034         *
035         * @param requestor
036         * @param invocation the remote invocation to send
037         * @throws javax.jms.JMSException if the message could not be created
038         */
039        Message createRequestMessage(Requestor requestor, LingoInvocation invocation) throws JMSException;
040    
041        /**
042         * Extracts the invocation result from the response message
043         *
044         * @param message the response message
045         * @return the invocation result
046         * @throws javax.jms.JMSException is thrown if a JMS exception occurs
047         */
048        RemoteInvocationResult extractInvocationResult(Message message) throws JMSException;
049    
050        /**
051         * Read a RemoteInvocation from the given JMS message
052         *
053         * @param message current JMS message
054         * @return the RemoteInvocation object
055         */
056        RemoteInvocation readRemoteInvocation(Message message) throws JMSException;
057    }