com.consol.citrus.endpoint.EndpointFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2006-2014 the original author or authors.
 *
 * Licensed 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 com.consol.citrus.endpoint;

import com.consol.citrus.context.TestContext;

import java.lang.annotation.Annotation;

/**
 * Endpoint factory tries to get endpoint instance by parsing an endpoint uri. Uri can have parameters
 * that get passed to the endpoint configuration.
 *
 * If Spring application context is given searches for matching endpoint component bean and delegates to component for
 * endpoint creation.
 *
 * @author Christoph Deppisch
 * @since 1.4.1
 */
public interface EndpointFactory {

    /**
     * Finds endpoint by parsing the given endpoint uri. The test context helps to create endpoints
     * by providing the Spring application context so registered beans and bean references can be set as
     * configuration properties.
     *
     * @param endpointUri
     * @param context
     * @return
     */
    Endpoint create(String endpointUri, TestContext context);

    /**
     * Finds endpoint by parsing the given endpoint annotation. The test context helps to create endpoints
     * by providing the Spring application context so registered beans and bean references can be set as
     * configuration properties.
     *
     * @param endpointName
     * @param endpointConfig
     * @param context
     * @return
     */
    Endpoint create(String endpointName, Annotation endpointConfig, TestContext context);
}