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 java.util.Map;
020
021import org.apache.camel.CamelContext;
022import org.apache.camel.EndpointProducerResolver;
023import org.apache.camel.Expression;
024
025/**
026 * Type-safe endpoint DSL for building producer endpoints.
027 *
028 * @see EndpointConsumerBuilder
029 */
030public interface EndpointProducerBuilder extends EndpointProducerResolver {
031    /**
032     * Builds the url of this endpoint. This API is only intended for Camel
033     * internally.
034     */
035    String getUri();
036
037    /**
038     * Adds an option to this endpoint. This API is only intended for Camel
039     * internally.
040     */
041    void doSetProperty(String name, Object value);
042
043    /**
044     * Adds a multi-value option to this endpoint. This API is only intended for Camel
045     * internally.
046     */
047    void doSetMultiValueProperty(String name, String key, Object value);
048
049    /**
050     * Adds multi-value options to this endpoint. This API is only intended for Camel
051     * internally.
052     */
053    void doSetMultiValueProperties(String name, String prefix, Map<String, Object> values);
054
055    /**
056     * Builds an expression of this endpoint url. This API is only intended for
057     * Camel internally.
058     */
059    Expression expr();
060
061    /**
062     * Builds a dynamic expression of this endpoint url. This API is only intended for
063     * Camel internally.
064     */
065    Expression expr(CamelContext camelContext);
066
067}