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.camel.component.stub;
018
019import java.util.concurrent.BlockingQueue;
020
021import org.apache.camel.Component;
022import org.apache.camel.Exchange;
023import org.apache.camel.Processor;
024import org.apache.camel.Producer;
025import org.apache.camel.WaitForTaskToComplete;
026import org.apache.camel.component.seda.BlockingQueueFactory;
027import org.apache.camel.component.seda.SedaProducer;
028import org.apache.camel.component.vm.VmConsumer;
029import org.apache.camel.component.vm.VmEndpoint;
030import org.apache.camel.spi.UriEndpoint;
031
032/**
033 * The stub component provides a simple way to stub out any physical endpoints while in development or testing.
034 *
035 * For example to run a route without needing to actually connect to a specific SMTP or HTTP endpoint.
036 * Just add stub: in front of any endpoint URI to stub out the endpoint.
037 * Internally the Stub component creates VM endpoints. The main difference between Stub and VM is that VM
038 * will validate the URI and parameters you give it, so putting vm: in front of a typical URI with
039 * query arguments will usually fail. Stub won't though, as it basically ignores all query parameters
040 * to let you quickly stub out one or more endpoints in your route temporarily.
041 */
042@UriEndpoint(firstVersion = "2.10.0", scheme = "stub", title = "Stub", syntax = "stub:name", consumerClass = VmConsumer.class, label = "core,testing")
043public class StubEndpoint extends VmEndpoint {
044
045    public StubEndpoint(String endpointUri, Component component, BlockingQueue<Exchange> queue) {
046        super(endpointUri, component, queue);
047    }
048
049    public StubEndpoint(String endpointUri, Component component, BlockingQueue<Exchange> queue, int concurrentConsumers) {
050        super(endpointUri, component, queue, concurrentConsumers);
051    }
052
053    public StubEndpoint(String endpointUri, Component component, BlockingQueueFactory<Exchange> queueFactory, int concurrentConsumers) {
054        super(endpointUri, component, queueFactory, concurrentConsumers);
055    }
056
057    @Override
058    protected StubConsumer createNewConsumer(Processor processor) {
059        return new StubConsumer(this, processor);
060    }
061
062    @Override
063    public Producer createProducer() throws Exception {
064        return new StubProducer(this, getWaitForTaskToComplete(), getTimeout(), isBlockWhenFull());
065    }
066}