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.impl;
018
019import org.apache.camel.CamelContext;
020import org.apache.camel.Endpoint;
021import org.apache.camel.spi.HeaderFilterStrategy;
022import org.apache.camel.spi.HeaderFilterStrategyAware;
023import org.apache.camel.spi.Metadata;
024
025/**
026 * Base class for components to support configuring a {@link org.apache.camel.spi.HeaderFilterStrategy}.
027 */
028public abstract class HeaderFilterStrategyComponent extends UriEndpointComponent implements HeaderFilterStrategyAware {
029
030    @Metadata(label = "filter", description = "To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.")
031    private HeaderFilterStrategy headerFilterStrategy;
032    
033    public HeaderFilterStrategyComponent(Class<? extends Endpoint> endpointClass) {
034        super(endpointClass);
035    }
036
037    public HeaderFilterStrategyComponent(CamelContext context, Class<? extends Endpoint> endpointClass) {
038        super(context, endpointClass);
039    }
040    
041    public HeaderFilterStrategy getHeaderFilterStrategy() {
042        return headerFilterStrategy;
043    }
044
045    /**
046     * To use a custom {@link org.apache.camel.spi.HeaderFilterStrategy} to filter header to and from Camel message.
047     */
048    public void setHeaderFilterStrategy(HeaderFilterStrategy strategy) {
049        headerFilterStrategy = strategy;
050    }
051
052    /**
053     * Sets the header filter strategy to use from the given endpoint if the endpoint is a {@link HeaderFilterStrategyAware} type.
054     */
055    public void setEndpointHeaderFilterStrategy(Endpoint endpoint) {
056        if (headerFilterStrategy != null && endpoint instanceof HeaderFilterStrategyAware) {
057            ((HeaderFilterStrategyAware)endpoint).setHeaderFilterStrategy(headerFilterStrategy);
058        }
059    }
060}