01: /* ***** BEGIN LICENSE BLOCK *****
02: * Version: MPL 1.1
03: * The contents of this file are subject to the Mozilla Public License Version
04: * 1.1 (the "License"); you may not use this file except in compliance with
05: * the License. You may obtain a copy of the License at
06: * http://www.mozilla.org/MPL/
07: *
08: * Software distributed under the License is distributed on an "AS IS" basis,
09: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10: * for the specific language governing rights and limitations under the
11: * License.
12: *
13: * The Original Code is Riot.
14: *
15: * The Initial Developer of the Original Code is
16: * Neteye GmbH.
17: * Portions created by the Initial Developer are Copyright (C) 2006
18: * the Initial Developer. All Rights Reserved.
19: *
20: * Contributor(s):
21: * Felix Gnass [fgnass at neteye dot de]
22: *
23: * ***** END LICENSE BLOCK ***** */
24: package org.riotfamily.common.web.mapping;
25:
26: import javax.servlet.http.HttpServletRequest;
27:
28: import org.springframework.web.servlet.HandlerMapping;
29:
30: /**
31: * Interface that can be implemented by {@link HandlerMapping HandlerMappings}
32: * in order to allow reverse lookups. This way you can obtain an URL for a
33: * mapped handler.
34: *
35: * @author Felix Gnass [fgnass at neteye dot de]
36: * @since 6.5
37: */
38: public interface ReverseHandlerMapping {
39:
40: /**
41: * Name of the {@link HttpServletRequest} attribute that contains the
42: * beanName of the matched handler.
43: * <p>Note: This attribute is not required to be supported by all
44: * ReverseHandlerMapping implementations.
45: */
46: String TOP_LEVEL_HANDLER_NAME_ATTRIBUTE = ReverseHandlerMapping.class
47: .getName()
48: + ".topLevelHandlerName";
49:
50: /**
51: * Returns the URL of a mapped handler.
52: * @param handlerName The name of the handler
53: * @param prefix Optional prefix to sort out ambiguities
54: * @param attributes Optional attributes to fill out wildcards. Can either
55: * be <code>null</code>, a primitive wrapper, a Map or a bean.
56: * @param request The current request
57: */
58: public String getUrlForHandler(String handlerName, String prefix,
59: Object attributes, HttpServletRequest request);
60:
61: }
|