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.processor.interceptor;
018    
019    import java.util.List;
020    
021    import org.apache.camel.CamelContext;
022    import org.apache.camel.Processor;
023    import org.apache.camel.model.ProcessorDefinition;
024    import org.apache.camel.spi.InterceptStrategy;
025    
026    /**
027     * {@link InterceptStrategy} implementation to configure stream caching on a RouteContext
028     */
029    public final class StreamCaching implements InterceptStrategy {
030        
031        public Processor wrapProcessorInInterceptors(CamelContext context, ProcessorDefinition<?> definition,
032                                                     Processor target, Processor nextTarget) throws Exception {
033            return new StreamCachingInterceptor(target);
034        }
035        
036        /**
037         * A helper method to return the StreamCaching instance
038         * for a given {@link org.apache.camel.CamelContext} if one is enabled
039         *
040         * @param context the camel context the stream cache is connected to
041         * @return the stream cache or null if none can be found
042         */
043        public static StreamCaching getStreamCaching(CamelContext context) {
044            return getStreamCaching(context.getInterceptStrategies());
045        }
046    
047        /**
048         * A helper method to return the StreamCaching instance
049         * for a given list of interceptors
050         *
051         * @param interceptors the list of interceptors
052         * @return the stream cache or null if none can be found
053         */
054        public static StreamCaching getStreamCaching(List<InterceptStrategy> interceptors) {
055            for (InterceptStrategy interceptStrategy : interceptors) {
056                if (interceptStrategy instanceof StreamCaching) {
057                    return (StreamCaching)interceptStrategy;
058                }
059            }
060            return null;
061        }
062    
063        /**
064         * Remove the {@link StreamCachingInterceptor} from the given list of interceptors
065         *
066         * @param interceptors the list of interceptors
067         */
068        public static void noStreamCaching(List<InterceptStrategy> interceptors) {
069            for (InterceptStrategy strategy : interceptors) {
070                if (strategy instanceof StreamCaching) {
071                    interceptors.remove(strategy);
072                }
073            }
074        }
075    
076        @Override
077        public String toString() {
078            return "StreamCaching";
079        }
080    }