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  
20  package org.apache.myfaces.tobago.util;
21  
22  import org.apache.myfaces.tobago.context.ClientProperties;
23  
24  import javax.el.ELContext;
25  import javax.faces.context.FacesContext;
26  
27  public final class VariableResolverUtils {
28  
29    private VariableResolverUtils() {
30      // utils class
31    }
32  
33    /**
34     * Returns the requested object configured in the faces-config or from library.
35     */
36    public static Object resolveVariable(final FacesContext context, final String variable) {
37      final ELContext elContext = context.getELContext();
38      return elContext.getELResolver().getValue(elContext, null, variable);
39    }
40  
41    /**
42     * Returns the ClientProperties object configured in the faces-config.
43     *
44     * @deprecated Since 2.0.0. Please use
45     * {@link org.apache.myfaces.tobago.context.ClientProperties#getInstance(javax.faces.context.FacesContext)}
46     */
47    @Deprecated
48    public static ClientProperties resolveClientProperties(final FacesContext facesContext) {
49      return ClientProperties.getInstance(facesContext);
50    }
51    
52    /**
53     * Clears the value of the variable.
54     * Useful for cleaning up e.g. a session or application variable
55     * to save memory without the knowledge of the scope.
56     * Also useful to enforce a new creation of a managed-bean.
57     */
58    public static void clearVariable(final FacesContext context, final String variable) {
59      final ELContext elContext = context.getELContext();
60      elContext.getELResolver().setValue(elContext, null, variable, null);
61    }
62  }