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.http;
29
30 import org.apache.hc.core5.http.protocol.HttpContext;
31
32 /**
33 * This class can be used to resolve an object matching a particular {@link HttpRequest}.
34 * Usually the mapped object will be a request handler to process the request.
35 *
36 * @since 5.0
37 */
38 public interface HttpRequestMapper<T> {
39
40 /**
41 * Resolves a handler matching the given request.
42 *
43 * @param request the request to map to a handler
44 * @return HTTP request handler or {@code null} if no match
45 * is found.
46 */
47 T resolve(HttpRequest request, HttpContext context) throws HttpException;
48
49 }