1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.hc.core5.http2;
29
30 import java.util.List;
31
32 import org.apache.hc.core5.http.Header;
33 import org.apache.hc.core5.http.HttpException;
34 import org.apache.hc.core5.http.HttpMessage;
35
36 /**
37 * Abstract message converter intended to convert from a list of HTTP/2 headers to object
38 * representing an HTTP message and from an object representing an HTTP message to a list
39 * of HTTP/2 headers.
40 *
41 * @param <T> represents {@link HttpMessage}
42 *
43 * @since 5.0
44 */
45 public interface H2MessageConverter<T extends HttpMessage> {
46
47 /**
48 * Converts given list of HTTP/2 headers to a {@link HttpMessage}.
49 *
50 * @param headers list of HTTP/2 headers
51 * @return HTTP message
52 * @throws HttpException in case of HTTP protocol violation
53 */
54 T convert(List<Header> headers) throws HttpException;
55
56 /**
57 * Converts given {@link HttpMessage} to a list of HTTP/2 headers.
58 *
59 * @param message HTTP message
60 * @return list of HTTP/2 headers
61 * @throws HttpException in case of HTTP protocol violation
62 */
63 List<Header> convert(T message) throws HttpException;
64
65 }