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.dialog.basic;
19  
20  import org.apache.shale.dialog.basic.model.Dialog;
21  
22  /***
23   * <p>Manifest constants for the basic dialog state manager implementation.</p>
24   *
25   * @since 1.0.4
26   */
27  public class Globals {
28  
29  
30      /***
31       * <p>Context initialization paramater name under which a comma separated
32       * list of configuration resources to be parsed exists.</p>
33       */
34      public static final String CONFIGURATION =
35              "org.apache.shale.dialog.basic.CONFIGURATION";
36  
37  
38      /***
39       * <p>Application scope attribute under which a <code>Map</code> of
40       * {@link Dialog} definitions (keyed by dialog name) is stored.</p>
41       */
42      public static final String DIALOGS =
43              "org.apache.shale.dialog.basic.DIALOGS";
44  
45  
46      /***
47       * <p>Context initialization parameter name under which a strategy name
48       * for dealing with saving and restoring dialog context state information
49       * is specified.  Valid values are:</p>
50       * <ul>
51       * <li><code>none</code> - No extra information is stored (default).</li>
52       * <li><code>top</code> - Information from the top-most {@link Position}
53       *     on the stack, plus enough information to detect crossing a subdialog
54       *     boundary.  Such a case will cause an exception to be thrown.</li>
55       * <li><code>stack</code> - The entire stack of {@link Position}s, including
56       *     the corresponding data objects.<li>
57       * </ul>
58       *
59       * <p><strong>IMPLEMENTATION NOTE</strong> - The feature set supported by
60       * this context initialization parameter is experimental, and no guarantees
61       * of backwards compatibility in future versions should be assumed.</p>
62       */
63      public static final String STRATEGY =
64              "org.apache.shale.dialog.basic.STRATEGY";
65  
66  
67  }