KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > riotfamily > pages > mapping > PageLocationResolver


1 /* ***** BEGIN LICENSE BLOCK *****
2  * Version: MPL 1.1
3  * The contents of this file are subject to the Mozilla Public License Version
4  * 1.1 (the "License"); you may not use this file except in compliance with
5  * the License. You may obtain a copy of the License at
6  * http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * 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) 2007
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.pages.mapping;
25
26 import javax.servlet.http.HttpServletRequest JavaDoc;
27
28 import org.riotfamily.pages.Page;
29 import org.riotfamily.pages.PageLocation;
30
31
32 /**
33  * Interface that resolves the {@link PageLocation} for a request. The
34  * PageLocation can be passed to a PageDao in order to look up a Page.
35  * <p>
36  * Resolvers are virtually bidirectional as they can also be used to build
37  * URLs that point to a given Page.
38  *
39  * @author Felix Gnass [fgnass at neteye dot de]
40  * @author Jan-Frederic Linde [jfl at neteye dot de]
41  * @since 6.5
42  */
43 public interface PageLocationResolver {
44
45     /**
46      * Returns the {@link PageLocation} that should be used to look up the Page.
47      * Implementors may return <code>null</code> if it's obvious that a lookup
48      * will not yield any page.
49      */
50     public PageLocation getPageLocation(HttpServletRequest JavaDoc request);
51     
52     /**
53      * Returns an URL, which if requested will be mapped to the given Page.
54      * Implementors <em>should</em> return an URL relative to the context path
55      * but may also return an absolute URL (containing protocol and
56      * server name).
57      */
58     public String JavaDoc getUrl(Page page);
59
60 }
61
Popular Tags