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     */
017    package org.apache.camel.component.restlet;
018    
019    import java.io.IOException;
020    
021    import org.apache.camel.Exchange;
022    import org.restlet.data.Request;
023    import org.restlet.data.Response;
024    
025    /**
026     * Interface for converting between Camel message and Restlet message.
027     * 
028     * @version $Revision: 730506 $
029     */
030    public interface RestletBinding {
031        
032        /**
033         * Populate Restlet request from Camel message
034         *  
035         * @param exchange message to be copied from 
036         * @param response to be populated
037         */
038        void populateRestletResponseFromExchange(Exchange exchange,
039                Response response);
040    
041        /**
042         * Populate Camel message from Restlet request
043         * 
044         * @param request message to be copied from
045         * @param exchange to be populated
046         * @throws Exception 
047         */
048        void populateExchangeFromRestletRequest(Request request, 
049                Exchange exchange) throws Exception;
050    
051        /**
052         * Populate Restlet Request from Camel message
053         * 
054         * @param request to be populated
055         * @param exchange message to be copied from
056         */
057        void populateRestletRequestFromExchange(Request request, Exchange exchange);
058    
059        /**
060         * Populate Camel message from Restlet response
061         * 
062         * @param exchange to be populated
063         * @param response message to be copied from
064         * @throws IOException 
065         */
066        void populateExchangeFromRestletResponse(Exchange exchange,
067                Response response) throws IOException;
068    
069    }