View Javadoc
1   /**
2    * This file Copyright (c) 2010-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.util;
35  
36  import java.util.Collections;
37  import java.util.Enumeration;
38  import java.util.HashMap;
39  import java.util.Map;
40  
41  import javax.servlet.ServletConfig;
42  import javax.servlet.ServletContext;
43  
44  /**
45   * Custom {@link javax.servlet.ServletConfig} for manually initializing servlets.
46   */
47  public class CustomServletConfig implements ServletConfig {
48  
49      private final String servletName;
50      private final ServletContext servletContext;
51      private final Map<String, String> initParameters;
52  
53      public CustomServletConfig(String servletName, ServletContext servletContext, Map<String, String> initParameters) {
54          if (initParameters == null) {
55              throw new IllegalArgumentException("initParameters can't be null. Something must be wrong.");
56          }
57          this.servletName = servletName;
58          this.servletContext = servletContext;
59          this.initParameters = initParameters;
60      }
61  
62      /**
63       * @deprecated since 5.3.3 - not used
64       */
65      @Deprecated
66      public CustomServletConfig(String servletName, ServletContext servletContext) {
67          this(servletName, servletContext, new HashMap<String, String>());
68      }
69  
70      @Override
71      public String getServletName() {
72          return servletName;
73      }
74  
75      @Override
76      public ServletContext getServletContext() {
77          return servletContext;
78      }
79  
80      @Override
81      public String getInitParameter(String name) {
82          return this.initParameters.get(name);
83      }
84  
85      @Override
86      public Enumeration getInitParameterNames() {
87          return Collections.enumeration(initParameters.keySet());
88      }
89  }