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.dataset;
018    
019    import org.apache.camel.Exchange;
020    
021    /**
022     * Represents a strategy for testing endpoints with canned data.
023     *
024     * @version $Revision: 585 $
025     */
026    public interface DataSet {
027    
028        String INDEX_HEADER = "camelDataSetIndex";
029    
030        /**
031         * Populates a message exchange when using the DataSet as a source of messages
032         *
033         * @param exchange
034         */
035        void populateMessage(Exchange exchange, long messageIndex) throws Exception;
036    
037        /**
038         * Returns the size of the dataset
039         */
040        long getSize();
041    
042        /**
043         * Asserts that the expected message has been received for the given index
044         */
045        void assertMessageExpected(DataSetEndpoint dataSetEndpoint, Exchange expected, Exchange actual, long index) throws Exception;
046    
047        /**
048         * Returns the number of messages which should be received before reporting on the progress of the test
049         */
050        long getReportCount();
051    }