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.orchestra.lib.jsf;
20  
21  import java.util.ArrayList;
22  import java.util.Collections;
23  import java.util.List;
24  import java.util.Map;
25  
26  /**
27   * Utility methods for configuring the behaviour of a JSF-based Orchestra installation.
28   * 
29   * @since 1.1
30   */
31  public abstract class ConfigUtils
32  {
33      private static final String RH_KEY = ConfigUtils.class.getName() + ".RH";
34  
35      static List getRequestHandlers(Map reqScope)
36      {
37          List rhl = (List) reqScope.get(RH_KEY);
38          if (rhl != null)
39          {
40              return rhl;
41          }
42          else
43          {
44              return Collections.EMPTY_LIST;
45          }
46      }
47  
48      /**
49       * Can be called from a Filter or similar class in order to registed a
50       * handler that should be run at the start of each request just
51       * <i>after</i> the FacesContext object has been created, and at the end
52       * of each request just <i>before</i> the FacesContext is released.
53       */
54      public static void registerRequestHandler(Map reqScope, RequestHandler rh)
55      {
56          List rhl = (List) reqScope.get(RH_KEY);
57          if (rhl == null)
58          {
59              rhl = new ArrayList(1);
60              reqScope.put(RH_KEY, rhl);
61          }
62          rhl.add(rh);
63      }
64  }