org.apache.camel.spi.MockSendToEndpointStrategyFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation

The Camel API

The newest version!

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.camel.spi;

/**
 * Factory for intercepting sending to endpoint pattern and sending to mock component. This requires having camel-mock
 * on the classpath.
 */
public interface MockSendToEndpointStrategyFactory {

    String FACTORY = "mock-send-to-endpoint-strategy-factory";

    /**
     * Mock sending to endpoint
     *
     * @param  pattern pattern for intercepting (null or * = intercept all, otherwise its an text pattern (and regexp).
     * @param  skip    whether to skip sending to original endpoint (only to mock endpoint).
     * @return         the endpoint strategy that intercepts.
     */
    EndpointStrategy mock(String pattern, boolean skip);

}