1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts;
20
21 /**
22 * Encapsulates the mapping of URIs to Web Scripts
23 */
24 public interface UriIndex
25 {
26 /**
27 * Clear the index
28 */
29 public void clear();
30
31 /**
32 * Gets size of index (i.e. number of Uris indexed)
33 *
34 * @return index size
35 */
36 public int getSize();
37
38 /**
39 * Register a URI with a Web Script
40 *
41 * @param script
42 * @param uri
43 */
44 public void registerUri(WebScript script, String uri);
45
46 /**
47 * Gets a Web Script given an HTTP Method and URI
48 *
49 * @param method http method
50 * @param uri uri
51 * @return script match (pair of script and uri that matched)
52 */
53 public Match findWebScript(String method, String uri);
54 }