1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. 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,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.myfaces.application;
20
21 import javax.faces.context.FacesContext;
22
23 /**
24 * A utility class to isolate a ViewHandler implementation from the underlying
25 * request/response framework.
26 * <p>
27 * For example, an implementation of this interface might support javax.servlet,
28 * javax.portlet, or some other mechanism.
29 *
30 * @author Mathias Broekelmann (latest modification by $Author: skitching $)
31 * @version $Revision: 589835 $ $Date: 2007-10-29 15:10:36 -0500 (Mon, 29 Oct 2007) $
32 */
33 public interface ViewHandlerSupport
34 {
35 String calculateViewId(FacesContext context, String viewId);
36
37 /**
38 * Return a string containing a webapp-relative URL that the user can invoke
39 * to render the specified view.
40 * <p>
41 * URLs and ViewIds are not quite the same; for example a url of "/foo.jsf"
42 * or "/faces/foo.jsp" may be needed to access the view "/foo.jsp".
43 */
44 String calculateActionURL(FacesContext facesContext, String viewId);
45 }