Debian Codegraph @

jersey-servlet/src/main/java/com/sun/jersey/spi/container/servlet/WebConfig.java

raw
1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can
10 * obtain a copy of the License at
11 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
12 * or packager/legal/LICENSE.txt. See the License for the specific
13 * language governing permissions and limitations under the License.
14 *
15 * When distributing the software, include this License Header Notice in each
16 * file and include the License file at packager/legal/LICENSE.txt.
17 *
18 * GPL Classpath Exception:
19 * Oracle designates this particular file as subject to the "Classpath"
20 * exception as provided by Oracle in the GPL Version 2 section of the License
21 * file that accompanied this code.
22 *
23 * Modifications:
24 * If applicable, add the following below the License Header, with the fields
25 * enclosed by brackets [] replaced by your own identifying information:
26 * "Portions Copyright [year] [name of copyright owner]"
27 *
28 * Contributor(s):
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41 package com.sun.jersey.spi.container.servlet;
42
43 import com.sun.jersey.api.core.ResourceConfig;
44
45 import javax.servlet.ServletContext;
46 import javax.servlet.ServletException;
47 import java.util.Enumeration;
48 import java.util.Map;
49
50 /**
51 * The Web configuration for accessing initialization parameters of a Web
52 * component and the {@link ServletContext}.
53 *
54 * @author [email protected]
55 */
56 public interface WebConfig {
57
58 /**
59 * The web configuration type.
60 */
61 public static enum ConfigType {
62 /**
63 * A configuration type of servlet configuration.
64 */
65 ServletConfig,
66 /**
67 * A configuration type of filter configuration.
68 */
69 FilterConfig
70 }
71
72 /**
73 * Get the configuration type of this config.
74 *
75 * @return the configuration type.
76 */
77 ConfigType getConfigType();
78
79 /**
80 * Get the name of the Web component.
81 *
82 * @return the name of the Web component.
83 */
84 String getName();
85
86 /**
87 * Get an initialization parameter.
88 *
89 * @param name the parameter name.
90 * @return the parameter value, or null if the parameter is not present.
91 */
92 String getInitParameter(String name);
93
94 /**
95 * Get the enumeration of initialization parameter names.
96 *
97 * @return the enumeration of initialization parameter names.
98 */
99 Enumeration getInitParameterNames();
100
101 /**
102 * Get the {@link ServletContext}.
103 *
104 * @return the {@link ServletContext}.
105 */
106 ServletContext getServletContext();
107
108 /**
109 * Get the default {@link ResourceConfig}.
110 *
111 * @param props the map of properties.
112 *
113 * @return the default {@link ResourceConfig}.
114 * @throws javax.servlet.ServletException
115 */
116 ResourceConfig getDefaultResourceConfig(Map<String, Object> props) throws ServletException;
117 }