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     */
017    package org.apache.camel.spi;
018    
019    import org.apache.camel.Endpoint;
020    
021    /**
022     * Endpoint strategy with callback invoked when an {@link org.apache.camel.Endpoint} is about to be registered to the
023     * endopoint registry in {@link org.apache.camel.CamelContext}. This callback allows you to interveave
024     * and return a mixed in {@link org.apache.camel.Endpoint}.
025     * <p/>
026     * The {@link org.apache.camel.model.InterceptSendToEndpointDefinition} uses this to allow it to proxy
027     * endpoints so it can intercept sending to the given endpoint.
028     *
029     * @version $Revision: 771301 $
030     */
031    public interface EndpointStrategy {
032    
033        // TODO: Add more strategy methods for other endpoint related methods, such as lookup, remove etc.
034        // and add a base class EndpointStrategySupport that has noop impl of all methods so you can extend it
035        // if you only want to do custom behavior in one of the methods
036    
037        /**
038         * Register the endpoint.
039         *
040         * @param uri  uri of endpoint
041         * @param endpoint the current endpoint to register
042         * @return the real endpoint to register, for instance a wrapped/enhanced endpoint.
043         */
044        Endpoint registerEndpoint(String uri, Endpoint endpoint);
045    
046    }