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.http.nio.protocol;
29
30 import java.util.Map;
31
32 import org.apache.http.annotation.ThreadingBehavior;
33 import org.apache.http.annotation.Contract;
34 import org.apache.http.protocol.UriPatternMatcher;
35
36 /**
37 * Maintains a map of HTTP request handlers keyed by a request URI pattern.
38 * <br>
39 * Patterns may have three formats:
40 * <ul>
41 * <li>{@code *}</li>
42 * <li>{@code *<uri>}</li>
43 * <li>{@code <uri>*}</li>
44 * </ul>
45 * <br>
46 * This class can be used to resolve an instance of {@link HttpAsyncRequestHandler}
47 * matching a particular request URI. Usually the resolved request handler
48 * will be used to process the request with the specified request URI.
49 *
50 * @since 4.2
51 * @deprecated (4.3) use {@link UriHttpAsyncRequestHandlerMapper}
52 */
53 @Contract(threading = ThreadingBehavior.SAFE)
54 @Deprecated
55 public class HttpAsyncRequestHandlerRegistry implements HttpAsyncRequestHandlerResolver {
56
57 private final UriPatternMatcher<HttpAsyncRequestHandler<?>> matcher;
58
59 public HttpAsyncRequestHandlerRegistry() {
60 matcher = new UriPatternMatcher<HttpAsyncRequestHandler<?>>();
61 }
62
63 /**
64 * Registers the given {@link HttpAsyncRequestHandler} as a handler for URIs
65 * matching the given pattern.
66 *
67 * @param pattern the pattern to register the handler for.
68 * @param handler the handler.
69 */
70 public void register(final String pattern, final HttpAsyncRequestHandler<?> handler) {
71 matcher.register(pattern, handler);
72 }
73
74 /**
75 * Removes registered handler, if exists, for the given pattern.
76 *
77 * @param pattern the pattern to unregister the handler for.
78 */
79 public void unregister(final String pattern) {
80 matcher.unregister(pattern);
81 }
82
83 /**
84 * Sets handlers from the given map.
85 * @param map the map containing handlers keyed by their URI patterns.
86 */
87 public void setHandlers(final Map<String, HttpAsyncRequestHandler<?>> map) {
88 matcher.setObjects(map);
89 }
90
91 /**
92 * Get the handler map.
93 * @return The map of handlers and their associated URI patterns.
94 */
95 public Map<String, HttpAsyncRequestHandler<?>> getHandlers() {
96 return matcher.getObjects();
97 }
98
99 @Override
100 public HttpAsyncRequestHandler<?> lookup(final String requestURI) {
101 return matcher.lookup(requestURI);
102 }
103
104 }