NettyHttpBinding.java

/**
 * 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.camel.component.netty4.http;

import java.util.Map;

import io.netty.handler.codec.http.FullHttpRequest;
import io.netty.handler.codec.http.FullHttpResponse;
import io.netty.handler.codec.http.HttpRequest;
import io.netty.handler.codec.http.HttpResponse;
import org.apache.camel.Exchange;
import org.apache.camel.Message;
import org.apache.camel.spi.HeaderFilterStrategy;

/**
 * To bind Netty http codec with the Camel {@link org.apache.camel.Message} api.
 */
public interface NettyHttpBinding {

    /**
     * Binds from Netty {@link HttpRequest} to Camel {@link Message}.
     * <p/>
     * Will use the <tt>populateCamelHeaders</tt> method for populating the headers.
     *
     * @param request       the netty http request
     * @param exchange      the exchange that should contain the returned message.
     * @param configuration the endpoint configuration
     * @return the message to store on the given exchange
     * @throws Exception is thrown if error during binding
     */
    Message toCamelMessage(FullHttpRequest request, Exchange exchange, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Binds from Netty {@link HttpRequest} to Camel headers as a {@link Map}.
     *
     * @param request       the netty http request
     * @param headers       the Camel headers that should be populated
     * @param exchange      the exchange that should contain the returned message.
     * @param configuration the endpoint configuration
     * @throws Exception is thrown if error during binding
     */
    void populateCamelHeaders(FullHttpRequest request, Map<String, Object> headers, Exchange exchange, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Binds from Netty {@link HttpResponse} to Camel {@link Message}.
     * <p/>
     * Will use the <tt>populateCamelHeaders</tt> method for populating the headers.
     *
     * @param response      the netty http response
     * @param exchange      the exchange that should contain the returned message.
     * @param configuration the endpoint configuration
     * @return the message to store on the given exchange
     * @throws Exception is thrown if error during binding
     */
    Message toCamelMessage(FullHttpResponse response, Exchange exchange, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Binds from Netty {@link HttpResponse} to Camel headers as a {@link Map}.
     *
     * @param response      the netty http response
     * @param headers       the Camel headers that should be populated
     * @param exchange      the exchange that should contain the returned message.
     * @param configuration the endpoint configuration
     * @throws Exception is thrown if error during binding
     */
    void populateCamelHeaders(FullHttpResponse response, Map<String, Object> headers, Exchange exchange, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Binds from Camel {@link Message} to Netty {@link HttpResponse}.
     *
     * @param message       the Camel message
     * @param configuration the endpoint configuration
     * @return the http response
     * @throws Exception is thrown if error during binding
     */
    HttpResponse toNettyResponse(Message message, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Binds from Camel {@link Message} to Netty {@link io.netty.handler.codec.http.HttpRequest}.
     *
     * @param message       the Camel message
     * @param uri           the uri which is the intended uri to call, though the message may override the uri
     * @param configuration the endpoint configuration
     * @return the http request
     * @throws Exception is thrown if error during binding
     */
    HttpRequest toNettyRequest(Message message, String uri, NettyHttpConfiguration configuration) throws Exception;

    /**
     * Gets the header filter strategy
     *
     * @return the strategy
     */
    HeaderFilterStrategy getHeaderFilterStrategy();

    /**
     * Sets the header filter strategy to use.
     *
     * @param headerFilterStrategy the custom strategy
     */
    void setHeaderFilterStrategy(HeaderFilterStrategy headerFilterStrategy);

}