org.apache.synapse.transport.passthru.config.TargetConfiguration Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of synapse-nhttp-transport
Apache Synapse - Non-blocking HTTP/s Transport
There is a newer version: 3.0.2
/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

package org.apache.synapse.transport.passthru.config;

import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.description.ParameterInclude;
import org.apache.axis2.transport.base.threads.WorkerPool;
import org.apache.http.protocol.*;
import org.apache.synapse.transport.passthru.connections.TargetConnections;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * This class stores configuration specific to HTTP Connectors (Senders)
 */
public class TargetConfiguration extends BaseConfiguration {

    private int maxConnections = Integer.MAX_VALUE;

    /** Whether User-Agent header coming from client should be preserved */
    private boolean preserveUserAgentHeader = false;

    /** Whether Server header coming from server should be preserved */
    private boolean preserveServerHeader = true;

    /** Http headers which should be preserved */
    private List preserveHttpHeaders;

    private TargetConnections connections = null;

    public TargetConfiguration(ConfigurationContext configurationContext,
                               ParameterInclude parameters,
                               WorkerPool pool) {
        super(configurationContext, parameters, pool);
        maxConnections = conf.getIntProperty(
                PassThroughConfigPNames.MAX_CONNECTION_PER_TARGET,
                Integer.MAX_VALUE);
        preserveUserAgentHeader = conf.getBooleanProperty(
                PassThroughConfigPNames.USER_AGENT_HEADER_PRESERVE, false);
        preserveServerHeader = conf.getBooleanProperty(
                PassThroughConfigPNames.SERVER_HEADER_PRESERVE, true);
        populatePreserveHttpHeaders(conf.getPreserveHttpHeaders());
    }

    @Override
    protected HttpProcessor initHttpProcessor() {
        String userAgent = conf.getStringProperty(
                PassThroughConfigPNames.USER_AGENT_HEADER_VALUE,
                "Synapse-PT-HttpComponents-NIO");
        return new ImmutableHttpProcessor(
                new RequestContent(),
                new RequestTargetHost(),
                new RequestConnControl(),
                new RequestUserAgent(userAgent),
                new RequestExpectContinue(false));
    }

    public int getMaxConnections() {
        return maxConnections;
    }

    /**
     * Check preserving status of the given http header name
     *
     * @param headerName http header name which need to check preserving status
     * @return preserving status of the given http header
     */
    public boolean isPreserveHttpHeader(String headerName) {

        if (preserveHttpHeaders == null || preserveHttpHeaders.isEmpty() || headerName == null) {
            return false;
        }
        return preserveHttpHeaders.contains(headerName.toUpperCase());
    }

    public TargetConnections getConnections() {
        return connections;
    }

    public void setConnections(TargetConnections connections) {
        this.connections = connections;
    }

    /**
     * Populate preserve http headers from comma separate string
     *
     * @param preserveHeaders Comma separated preserve enable http headers
     */
    private void populatePreserveHttpHeaders(String preserveHeaders) {

        preserveHttpHeaders = new ArrayList();
        if (preserveHeaders != null && !preserveHeaders.isEmpty()) {
            String[] presHeaders = preserveHeaders.trim().toUpperCase().split(",");
            if (presHeaders != null && presHeaders.length > 0) {
                preserveHttpHeaders.addAll(Arrays.asList(presHeaders));
            }
        }

        if (preserveServerHeader && !preserveHttpHeaders.contains(HTTP.SERVER_HEADER.toUpperCase())) {
            preserveHttpHeaders.add(HTTP.SERVER_HEADER.toUpperCase());
        }

        if (preserveUserAgentHeader && !preserveHttpHeaders.contains(HTTP.USER_AGENT.toUpperCase())) {
            preserveHttpHeaders.add(HTTP.USER_AGENT.toUpperCase());
        }
    }

}