View Javadoc

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