2009/05/20 - Apache Shale has been retired.

For more information, please explore the Attic.


1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to you under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shale.view;
19  
20  /***
21   * <p>Manifest constants related to Shale view support that are relevant
22   * to applications using Shale.</p>
23   */
24  public final class Constants {
25  
26  
27      // ------------------------------------------------------------ Constructors
28  
29  
30      /***
31       * <p>Private constructor to avoid instantiation.</p>
32       */
33      private Constants() { }
34  
35  
36      // ------------------------------------------------------ Manifest Constants
37  
38  
39  
40      /***
41       * <p>Name of the context initialization parameter that defines the
42       * context-relative path we should dispatch to, at the end of
43       * <em>Invoke Application</em> phase of the request processing lifecycle,
44       * if any application exceptions have been cached by the default
45       * {@link ExceptionHandler} instance.  If no value is specified, the
46       * default behavioer is to proceed to rendering for the view that the
47       * application has navigated to.</p>
48       *
49       * <p><strong>NOTE</strong> - in order to be processed correctly by the
50       * container, the specified path should be a context relative URL
51       * that beings with a '/' character.</p>
52       *
53       * @since 1.0.3
54       */
55      public static final String EXCEPTION_DISPATCH_PATH =
56        "org.apache.shale.view.EXCEPTION_DISPATCH_PATH";
57  
58  
59  
60      /***
61       * <p>Application scope attribute under which the
62       * {@link ExceptionHandler} for handling exceptions is stored.</p>
63       */
64      public static final String EXCEPTION_HANDLER =
65        "org$apache$shale$view$EXCEPTION_HANDLER";
66  
67  
68      /***
69       * <p>Name of the context initialization parameter that defines the
70       * fully qualified class name of the {@link ViewControllerMapper} to be
71       * used is stored.  If not present, the default value is
72       * <code>org.apache.shale.view.DefaultViewControllerMapper</code>.</p>
73       *
74       * @deprecated Replace the application scoped managed bean stored with
75       *  key Constants.VIEW_MAPPER instead
76       */
77      public static final String VIEW_CONTROLLER_MAPPER =
78        "org.apache.shale.view.VIEW_CONTROLLER_MAPPER";
79  
80  
81      /***
82       * <p>Application scope attribute under which the
83       * {@link ViewControllerMapper} for translating view identifiers
84       * to class names of the corresponding {@link ViewController}
85       * is stored.</p>
86       */
87      public static final String VIEW_MAPPER =
88        "org$apache$shale$view$VIEW_MAPPER";
89  
90  
91  }