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