View Javadoc

1   package org.apache.velocity.tools.view.tools;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import java.util.Map;
23  import org.apache.velocity.tools.view.ViewContext;
24  import org.apache.velocity.tools.view.ViewContextTool;
25  
26  /**
27   * Use {@link org.apache.velocity.tools.view.ViewContextTool}
28   */
29  @Deprecated
30  public class ContextTool extends ViewContextTool
31  {
32      @Deprecated
33      public static final String OLD_SAFE_MODE_KEY = "safe-mode";
34  
35      @Deprecated
36      public void init(Object obj)
37      {
38          if (obj instanceof ViewContext)
39          {
40              ViewContext ctx = (ViewContext)obj;
41              this.context = ctx.getVelocityContext();
42              this.request = ctx.getRequest();
43              this.session = request.getSession(false);
44              this.application = ctx.getServletContext();
45          }
46      }
47  
48      @Override
49      public void configure(Map params)
50      {
51          if (params != null)
52          {
53              // if we find a param under the old key
54              Object oldSafeMode = params.get(OLD_SAFE_MODE_KEY);
55              if (oldSafeMode != null)
56              {
57                  // copy it under the new one
58                  params.put(SAFE_MODE_KEY, oldSafeMode);
59              }
60              super.configure(params);
61          }
62      }
63  
64  }