WebApp


1   /*
2    * The contents of this file are subject to the terms of the Common Development
3    * and Distribution License (the License). You may not use this file except in
4    * compliance with the License.
5    *
6    * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7    * or http://www.netbeans.org/cddl.txt.
8    *
9    * When distributing Covered Code, include this CDDL Header Notice in each file
10   * and include the License file at http://www.netbeans.org/cddl.txt.
11   * If applicable, add the following below the CDDL Header, with the fields
12   * enclosed by brackets [] replaced by your own identifying information:
13   * "Portions Copyrighted [year] [name of copyright owner]"
14   *
15   * The Original Software is NetBeans. The Initial Developer of the Original
16   * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17   * Microsystems, Inc. All Rights Reserved.
18   */
19  
20  package org.netbeans.api.web.dd;
21  import org.netbeans.api.web.dd.common.VersionNotSupportedException;
22  /**
23   * Generated interface for WebApp element.<br>
24   * The WebApp object is the root of bean graph generated<br>
25   * for deployment descriptor(web.xml) file.<br>
26   * For getting the root (WebApp object) use the {@link DDProvider#getDDRoot} method.
27   *
28   *<p><b><font color="red"><em>Important note: Do not provide an implementation of this interface unless you are a DD API provider!</em></font></b>
29   *</p>
30   * @deprecated Use the API for web module deployment descriptor in j2ee/ddapi module.
31   */
32  public interface WebApp extends org.netbeans.api.web.dd.common.RootInterface {
33          public static final String   PROPERTY_VERSION="dd_version"; //NOI18N
34          public static final String   VERSION_2_3="2.3"; //NOI18N
35          public static final String   VERSION_2_4="2.4"; //NOI18N
36          public static final int STATE_VALID=0;
37          public static final int STATE_INVALID_PARSABLE=1;
38          public static final int STATE_INVALID_UNPARSABLE=2;
39          public static final String   PROPERTY_STATUS="dd_status"; //NOI18N
40      
41      //public void setVersion(java.lang.String value);
42          /** Getter for version property.
43           * @return property value
44           */        
45      public java.lang.String   getVersion();
46          /** Getter for SAX Parse Error property. 
47           * Used when deployment descriptor is in invalid state.
48           * @return property value or null if in valid state
49           */        
50      public org.xml.sax.SAXParseException   getError();      
51          /** Getter for status property.
52           * @return property value
53           */        
54      public int getStatus();      
55          /** Setter for distributable property.
56           * @param value property value
57           */
58          public void setDistributable(boolean value);
59          /** Getter for distributable property.
60           * @return property value 
61           */
62      public boolean isDistributable();        
63  
64      public void setContextParam(int index, org.netbeans.api.web.dd.InitParam valueInterface);
65  
66      public org.netbeans.api.web.dd.InitParam getContextParam(int index);
67  
68      public void setContextParam(org.netbeans.api.web.dd.InitParam[] value);
69  
70      public org.netbeans.api.web.dd.InitParam[] getContextParam();
71  
72      public int sizeContextParam();
73  
74      public int addContextParam(org.netbeans.api.web.dd.InitParam valueInterface);
75  
76      public int removeContextParam(org.netbeans.api.web.dd.InitParam valueInterface);
77  
78      public void setFilter(int index, org.netbeans.api.web.dd.Filter valueInterface);
79  
80      public org.netbeans.api.web.dd.Filter getFilter(int index);
81  
82      public void setFilter(org.netbeans.api.web.dd.Filter[] value);
83  
84      public org.netbeans.api.web.dd.Filter[] getFilter();
85  
86      public int sizeFilter();
87  
88      public int addFilter(org.netbeans.api.web.dd.Filter valueInterface);
89  
90      public int removeFilter(org.netbeans.api.web.dd.Filter valueInterface);
91  
92      public void setFilterMapping(int index, org.netbeans.api.web.dd.FilterMapping valueInterface);
93  
94      public org.netbeans.api.web.dd.FilterMapping getFilterMapping(int index);
95  
96      public void setFilterMapping(org.netbeans.api.web.dd.FilterMapping[] value);
97  
98      public org.netbeans.api.web.dd.FilterMapping[] getFilterMapping();
99  
100     public int sizeFilterMapping();
101 
102     public int addFilterMapping(org.netbeans.api.web.dd.FilterMapping valueInterface);
103 
104     public int removeFilterMapping(org.netbeans.api.web.dd.FilterMapping valueInterface);
105 
106     public void setListener(int index, org.netbeans.api.web.dd.Listener valueInterface);
107 
108     public org.netbeans.api.web.dd.Listener getListener(int index);
109 
110     public void setListener(org.netbeans.api.web.dd.Listener[] value);
111 
112     public org.netbeans.api.web.dd.Listener[] getListener();
113 
114     public int sizeListener();
115 
116     public int addListener(org.netbeans.api.web.dd.Listener valueInterface);
117 
118     public int removeListener(org.netbeans.api.web.dd.Listener valueInterface);
119 
120     public void setServlet(int index, org.netbeans.api.web.dd.Servlet valueInterface);
121 
122     public org.netbeans.api.web.dd.Servlet getServlet(int index);
123 
124     public void setServlet(org.netbeans.api.web.dd.Servlet[] value);
125 
126     public org.netbeans.api.web.dd.Servlet[] getServlet();
127 
128     public int sizeServlet();
129 
130     public int addServlet(org.netbeans.api.web.dd.Servlet valueInterface);
131 
132     public int removeServlet(org.netbeans.api.web.dd.Servlet valueInterface);
133 
134     public void setServletMapping(int index, org.netbeans.api.web.dd.ServletMapping valueInterface);
135 
136     public org.netbeans.api.web.dd.ServletMapping getServletMapping(int index);
137 
138     public void setServletMapping(org.netbeans.api.web.dd.ServletMapping[] value);
139 
140     public org.netbeans.api.web.dd.ServletMapping[] getServletMapping();
141 
142     public int sizeServletMapping();
143 
144     public int addServletMapping(org.netbeans.api.web.dd.ServletMapping valueInterface);
145 
146     public int removeServletMapping(org.netbeans.api.web.dd.ServletMapping valueInterface);
147 
148         public void setSessionConfig(org.netbeans.api.web.dd.SessionConfig value);
149     public org.netbeans.api.web.dd.SessionConfig getSingleSessionConfig();
150 
151     public void setMimeMapping(int index, org.netbeans.api.web.dd.MimeMapping valueInterface);
152 
153     public org.netbeans.api.web.dd.MimeMapping getMimeMapping(int index);
154 
155     public void setMimeMapping(org.netbeans.api.web.dd.MimeMapping[] value);
156 
157     public org.netbeans.api.web.dd.MimeMapping[] getMimeMapping();
158 
159     public int sizeMimeMapping();
160 
161     public int addMimeMapping(org.netbeans.api.web.dd.MimeMapping valueInterface);
162 
163     public int removeMimeMapping(org.netbeans.api.web.dd.MimeMapping valueInterface);
164 
165         public void setWelcomeFileList(org.netbeans.api.web.dd.WelcomeFileList value);
166         public org.netbeans.api.web.dd.WelcomeFileList getSingleWelcomeFileList();
167      
168     public void setErrorPage(int index, org.netbeans.api.web.dd.ErrorPage valueInterface);
169 
170     public org.netbeans.api.web.dd.ErrorPage getErrorPage(int index);
171 
172     public void setErrorPage(org.netbeans.api.web.dd.ErrorPage[] value);
173 
174     public org.netbeans.api.web.dd.ErrorPage[] getErrorPage();
175 
176     public int sizeErrorPage();
177 
178     public int addErrorPage(org.netbeans.api.web.dd.ErrorPage valueInterface);
179 
180     public int removeErrorPage(org.netbeans.api.web.dd.ErrorPage valueInterface);
181         
182     public void setJspConfig(org.netbeans.api.web.dd.JspConfig value) throws VersionNotSupportedException;
183     public org.netbeans.api.web.dd.JspConfig getSingleJspConfig() throws VersionNotSupportedException;
184 
185     public void setSecurityConstraint(int index, org.netbeans.api.web.dd.SecurityConstraint valueInterface);
186 
187     public org.netbeans.api.web.dd.SecurityConstraint getSecurityConstraint(int index);
188 
189     public void setSecurityConstraint(org.netbeans.api.web.dd.SecurityConstraint[] value);
190 
191     public org.netbeans.api.web.dd.SecurityConstraint[] getSecurityConstraint();
192 
193     public int sizeSecurityConstraint();
194 
195     public int addSecurityConstraint(org.netbeans.api.web.dd.SecurityConstraint valueInterface);
196 
197     public int removeSecurityConstraint(org.netbeans.api.web.dd.SecurityConstraint valueInterface);
198         
199     public void setLoginConfig(org.netbeans.api.web.dd.LoginConfig value);
200     public org.netbeans.api.web.dd.LoginConfig getSingleLoginConfig();
201 
202     public void setSecurityRole(int index, org.netbeans.api.web.dd.SecurityRole valueInterface);
203 
204     public org.netbeans.api.web.dd.SecurityRole getSecurityRole(int index);
205 
206     public void setSecurityRole(org.netbeans.api.web.dd.SecurityRole[] value);
207 
208     public org.netbeans.api.web.dd.SecurityRole[] getSecurityRole();
209 
210     public int sizeSecurityRole();
211 
212     public int addSecurityRole(org.netbeans.api.web.dd.SecurityRole valueInterface);
213 
214     public int removeSecurityRole(org.netbeans.api.web.dd.SecurityRole valueInterface);
215 
216     public void setEnvEntry(int index, org.netbeans.api.web.dd.EnvEntry valueInterface);
217 
218     public org.netbeans.api.web.dd.EnvEntry getEnvEntry(int index);
219 
220     public void setEnvEntry(org.netbeans.api.web.dd.EnvEntry[] value);
221 
222     public org.netbeans.api.web.dd.EnvEntry[] getEnvEntry();
223 
224     public int sizeEnvEntry();
225 
226     public int addEnvEntry(org.netbeans.api.web.dd.EnvEntry valueInterface);
227 
228     public int removeEnvEntry(org.netbeans.api.web.dd.EnvEntry valueInterface);
229 
230     public void setEjbRef(int index, org.netbeans.api.web.dd.EjbRef valueInterface);
231 
232     public org.netbeans.api.web.dd.EjbRef getEjbRef(int index);
233 
234     public void setEjbRef(org.netbeans.api.web.dd.EjbRef[] value);
235 
236     public org.netbeans.api.web.dd.EjbRef[] getEjbRef();
237 
238     public int sizeEjbRef();
239 
240     public int addEjbRef(org.netbeans.api.web.dd.EjbRef valueInterface);
241 
242     public int removeEjbRef(org.netbeans.api.web.dd.EjbRef valueInterface);
243 
244     public void setEjbLocalRef(int index, org.netbeans.api.web.dd.EjbLocalRef valueInterface);
245 
246     public org.netbeans.api.web.dd.EjbLocalRef getEjbLocalRef(int index);
247 
248     public void setEjbLocalRef(org.netbeans.api.web.dd.EjbLocalRef[] value);
249 
250     public org.netbeans.api.web.dd.EjbLocalRef[] getEjbLocalRef();
251 
252     public int sizeEjbLocalRef();
253 
254     public int addEjbLocalRef(org.netbeans.api.web.dd.EjbLocalRef valueInterface);
255 
256     public int removeEjbLocalRef(org.netbeans.api.web.dd.EjbLocalRef valueInterface);
257 
258     public void setServiceRef(int index, org.netbeans.api.web.dd.ServiceRef valueInterface) throws VersionNotSupportedException;
259 
260     public org.netbeans.api.web.dd.ServiceRef getServiceRef(int index) throws VersionNotSupportedException;
261 
262     public void setServiceRef(org.netbeans.api.web.dd.ServiceRef[] value) throws VersionNotSupportedException;
263 
264     public org.netbeans.api.web.dd.ServiceRef[] getServiceRef() throws VersionNotSupportedException;
265 
266     public int sizeServiceRef() throws VersionNotSupportedException;
267 
268     public int addServiceRef(org.netbeans.api.web.dd.ServiceRef valueInterface) throws VersionNotSupportedException;
269 
270     public int removeServiceRef(org.netbeans.api.web.dd.ServiceRef valueInterface) throws VersionNotSupportedException;
271 
272     public void setResourceRef(int index, org.netbeans.api.web.dd.ResourceRef valueInterface);
273 
274     public org.netbeans.api.web.dd.ResourceRef getResourceRef(int index);
275 
276     public void setResourceRef(org.netbeans.api.web.dd.ResourceRef[] value);
277 
278     public org.netbeans.api.web.dd.ResourceRef[] getResourceRef();
279 
280     public int sizeResourceRef();
281 
282     public int addResourceRef(org.netbeans.api.web.dd.ResourceRef valueInterface);
283 
284     public int removeResourceRef(org.netbeans.api.web.dd.ResourceRef valueInterface);
285 
286     public void setResourceEnvRef(int index, org.netbeans.api.web.dd.ResourceEnvRef valueInterface);
287 
288     public org.netbeans.api.web.dd.ResourceEnvRef getResourceEnvRef(int index);
289 
290     public void setResourceEnvRef(org.netbeans.api.web.dd.ResourceEnvRef[] value);
291 
292     public org.netbeans.api.web.dd.ResourceEnvRef[] getResourceEnvRef();
293 
294     public int sizeResourceEnvRef();
295 
296     public int addResourceEnvRef(org.netbeans.api.web.dd.ResourceEnvRef valueInterface);
297 
298     public int removeResourceEnvRef(org.netbeans.api.web.dd.ResourceEnvRef valueInterface);
299 
300     public void setMessageDestinationRef(int index, org.netbeans.api.web.dd.MessageDestinationRef valueInterface) throws VersionNotSupportedException;
301 
302     public org.netbeans.api.web.dd.MessageDestinationRef getMessageDestinationRef(int index) throws VersionNotSupportedException;
303 
304     public void setMessageDestinationRef(org.netbeans.api.web.dd.MessageDestinationRef[] value) throws VersionNotSupportedException;
305 
306     public org.netbeans.api.web.dd.MessageDestinationRef[] getMessageDestinationRef() throws VersionNotSupportedException;
307 
308     public int sizeMessageDestinationRef() throws VersionNotSupportedException;
309 
310     public int addMessageDestinationRef(org.netbeans.api.web.dd.MessageDestinationRef valueInterface) throws VersionNotSupportedException;
311 
312     public int removeMessageDestinationRef(org.netbeans.api.web.dd.MessageDestinationRef valueInterface) throws VersionNotSupportedException;
313 
314     public void setMessageDestination(int index, org.netbeans.api.web.dd.MessageDestination valueInterface) throws VersionNotSupportedException;
315 
316     public org.netbeans.api.web.dd.MessageDestination getMessageDestination(int index) throws VersionNotSupportedException;
317 
318     public void setMessageDestination(org.netbeans.api.web.dd.MessageDestination[] value) throws VersionNotSupportedException;
319 
320     public org.netbeans.api.web.dd.MessageDestination[] getMessageDestination() throws VersionNotSupportedException;
321 
322     public int sizeMessageDestination() throws VersionNotSupportedException;
323 
324     public int addMessageDestination(org.netbeans.api.web.dd.MessageDestination valueInterface) throws VersionNotSupportedException;
325 
326     public int removeMessageDestination(org.netbeans.api.web.dd.MessageDestination valueInterface) throws VersionNotSupportedException;
327 
328     public org.netbeans.api.web.dd.LocaleEncodingMappingList getSingleLocaleEncodingMappingList() throws VersionNotSupportedException;
329         
330     public void setLocaleEncodingMappingList(org.netbeans.api.web.dd.LocaleEncodingMappingList value) throws VersionNotSupportedException;
331 
332         // due to compatibility with servlet2.3
333     public void setTaglib(int index, org.netbeans.api.web.dd.Taglib valueInterface) throws VersionNotSupportedException;
334     public org.netbeans.api.web.dd.Taglib getTaglib(int index) throws VersionNotSupportedException;
335     public void setTaglib(org.netbeans.api.web.dd.Taglib[] value) throws VersionNotSupportedException;
336     public org.netbeans.api.web.dd.Taglib[] getTaglib() throws VersionNotSupportedException;
337     public int sizeTaglib() throws VersionNotSupportedException;
338     public int addTaglib(org.netbeans.api.web.dd.Taglib valueInterface) throws VersionNotSupportedException;
339     public int removeTaglib(org.netbeans.api.web.dd.Taglib valueInterface) throws VersionNotSupportedException;
340 }
341
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags