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.trinidad.context;
20  
21  /**
22   *  A page resolver is responsible for determining the physical page to
23   *  be used for a logical view ID.
24   *  <p>
25   *  By default, the physical page and logical view ID will be identical.
26   *  To override this, provide a file on the classpath at
27   *  <code>/META-INF/services/org.apache.myfaces.trinidad.context.PageResolver</code>
28   *  with the name of the alternative implementation.  (There's no current
29   *  support for decoration, and this general approach may be revisited
30   *  in the future.)
31   *  </p>
32   */
33  public abstract class PageResolver
34  {  
35    /**
36     * Constructor.
37     */
38    protected PageResolver()
39    {
40    }
41    
42    /**
43     * Performs mapping from a logical view ID to the physical page URI.
44     * @param viewId  the logical view ID.
45     * @return the URI of the page.
46     */
47    public abstract String getPhysicalURI(String viewId);
48    
49    /**
50     * Encodes an action URI.
51     */
52    public abstract String encodeActionURI(String actionURI);
53  }