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.builder;
018
019import org.apache.camel.CamelContext;
020import org.apache.camel.Endpoint;
021import org.apache.camel.Expression;
022import org.apache.camel.NoSuchEndpointException;
023
024/**
025 * Type-safe endpoint DSL for building producer endpoints.
026 *
027 * @see EndpointConsumerBuilder
028 */
029public interface EndpointProducerBuilder {
030
031    /**
032     * Builds and resolves this endpoint DSL as an endpoint.
033     *
034     * @param context the camel context
035     * @return a built {@link Endpoint}
036     * @throws NoSuchEndpointException is thrown if the endpoint
037     */
038    Endpoint resolve(CamelContext context) throws NoSuchEndpointException;
039
040    /**
041     * Builds the url of this endpoint. This API is only intended for Camel
042     * internally.
043     */
044    String getUri();
045
046    /**
047     * Adds an option to this endpoint. This API is only intended for Camel
048     * internally.
049     */
050    void doSetProperty(String name, Object value);
051
052    /**
053     * Builds an expression of this endpoint url. This API is only intended for
054     * Camel internally.
055     */
056    Expression expr();
057
058}