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