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