View Javadoc

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.shared.application;
20  
21  import javax.faces.context.FacesContext;
22  
23  /**
24   * TODO: RENAME - This class is now used by ViewDeclarationLanguageBase
25   * 
26   * A utility class to isolate a ViewHandler implementation from the underlying 
27   * request/response framework.
28   * <p>
29   * For example, an implementation of this interface might support javax.servlet,
30   * javax.portlet, or some other mechanism.
31   *    
32   * @author Mathias Broekelmann (latest modification by $Author: bommel $)
33   * @version $Revision: 1187701 $ $Date: 2011-10-22 07:21:54 -0500 (Sat, 22 Oct 2011) $
34   */
35  public interface ViewHandlerSupport
36  {
37      String calculateViewId(FacesContext context, String viewId);
38      
39      String calculateAndCheckViewId(FacesContext context, String viewId);
40  
41      /**
42       * Return a string containing a webapp-relative URL that the user can invoke
43       * to render the specified view.
44       * <p>
45       * URLs and ViewIds are not quite the same; for example a url of "/foo.jsf"
46       * or "/faces/foo.jsp" may be needed to access the view "/foo.jsp". 
47       */
48      String calculateActionURL(FacesContext facesContext, String viewId); 
49  }