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.nio.protocol;
29  
30  import org.apache.http.HttpRequest;
31  import org.apache.http.annotation.ThreadSafe;
32  import org.apache.http.protocol.UriPatternMatcher;
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 map an instance of {@link HttpAsyncRequestHandler}
46   * matching a particular request URI. Usually the mapped request handler
47   * will be used to process the request with the specified request URI.
48   *
49   * @since 4.3
50   */
51  @ThreadSafe
52  public class UriHttpAsyncRequestHandlerMapper implements HttpAsyncRequestHandlerMapper {
53  
54      private final UriPatternMatcher<HttpAsyncRequestHandler<?>> matcher;
55  
56      protected UriHttpAsyncRequestHandlerMapper(final UriPatternMatcher<HttpAsyncRequestHandler<?>> matcher) {
57          super();
58          this.matcher = Args.notNull(matcher, "Pattern matcher");
59      }
60  
61      public UriHttpAsyncRequestHandlerMapper() {
62          this(new UriPatternMatcher<HttpAsyncRequestHandler<?>>());
63      }
64  
65      /**
66       * Registers the given {@link HttpAsyncRequestHandler} as a handler for URIs
67       * matching the given pattern.
68       *
69       * @param pattern the pattern to register the handler for.
70       * @param handler the handler.
71       */
72      public void register(final String pattern, final HttpAsyncRequestHandler<?> 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       * Extracts request path from the given {@link HttpRequest}
87       */
88      protected String getRequestPath(final HttpRequest request) {
89          String uriPath = request.getRequestLine().getUri();
90          int index = uriPath.indexOf("?");
91          if (index != -1) {
92              uriPath = uriPath.substring(0, index);
93          } else {
94              index = uriPath.indexOf("#");
95              if (index != -1) {
96                  uriPath = uriPath.substring(0, index);
97              }
98          }
99          return uriPath;
100     }
101 
102     /**
103      * Looks up a handler matching the given request URI.
104      *
105      * @param request the request
106      * @return handler or {@code null} if no match is found.
107      */
108     @Override
109     public HttpAsyncRequestHandler<?> lookup(final HttpRequest request) {
110         return matcher.lookup(getRequestPath(request));
111     }
112 
113 }