Java > Open Source Codes > org > netbeans > modules > j2ee > sun > dd > api > web > SunWebApp


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  * SunWebApp.java
21  *
22  * Created on November 15, 2004, 4:26 PM
23  */
24
25 package org.netbeans.modules.j2ee.sun.dd.api.web;
26
27
28 import org.netbeans.modules.j2ee.sun.dd.api.VersionNotSupportedException;
29 import org.netbeans.modules.j2ee.sun.dd.api.common.EjbRef;
30 import org.netbeans.modules.j2ee.sun.dd.api.common.MessageDestination;
31 import org.netbeans.modules.j2ee.sun.dd.api.common.ResourceRef;
32 import org.netbeans.modules.j2ee.sun.dd.api.common.ResourceEnvRef;
33 import org.netbeans.modules.j2ee.sun.dd.api.common.ServiceRef;
34 import org.netbeans.modules.j2ee.sun.dd.api.common.WebserviceDescription;
35 import org.netbeans.modules.j2ee.sun.dd.api.common.SecurityRoleMapping;
36 import org.netbeans.modules.j2ee.sun.dd.api.common.MessageDestinationRef;
37
38 public interface SunWebApp extends org.netbeans.modules.j2ee.sun.dd.api.RootInterface {
39     
40         public static final String VERSION_2_5_0 = "2.50"; //NOI18N
41 public static final String VERSION_2_4_1 = "2.41"; //NOI18N
42 public static final String VERSION_2_4_0 = "2.40"; //NOI18N
43 public static final String VERSION_2_3_0 = "2.30"; //NOI18N
44
45         public static final String ERRORURL = "ErrorUrl"; // NOI18N
46 public static final String HTTPSERVLETSECURITYPROVIDER = "HttpservletSecurityProvider"; // NOI18N
47 public static final String CONTEXT_ROOT = "ContextRoot"; // NOI18N
48 public static final String SECURITY_ROLE_MAPPING = "SecurityRoleMapping"; // NOI18N
49 public static final String SERVLET = "Servlet"; // NOI18N
50 public static final String IDEMPOTENT_URL_PATTERN = "IdempotentUrlPattern"; // NOI18N
51 public static final String IDEMPOTENTURLPATTERNURLPATTERN = "IdempotentUrlPatternUrlPattern"; // NOI18N
52 public static final String IDEMPOTENTURLPATTERNNUMOFRETRIES = "IdempotentUrlPatternNumOfRetries"; // NOI18N
53 public static final String SESSION_CONFIG = "SessionConfig"; // NOI18N
54 public static final String EJB_REF = "EjbRef"; // NOI18N
55 public static final String RESOURCE_REF = "ResourceRef"; // NOI18N
56 public static final String RESOURCE_ENV_REF = "ResourceEnvRef"; // NOI18N
57 public static final String SERVICE_REF = "ServiceRef"; // NOI18N
58 public static final String CACHE = "Cache"; // NOI18N
59 public static final String CLASS_LOADER = "MyClassLoader"; // NOI18N
60 public static final String JSP_CONFIG = "JspConfig"; // NOI18N
61 public static final String LOCALE_CHARSET_INFO = "LocaleCharsetInfo"; // NOI18N
62 public static final String PARAMETER_ENCODING = "ParameterEncoding"; // NOI18N
63 public static final String PARAMETERENCODINGFORMHINTFIELD = "ParameterEncodingFormHintField"; // NOI18N
64 public static final String PARAMETERENCODINGDEFAULTCHARSET = "ParameterEncodingDefaultCharset"; // NOI18N
65 public static final String PROPERTY = "WebProperty"; // NOI18N
66 public static final String MESSAGE_DESTINATION = "MessageDestination"; // NOI18N
67 public static final String WEBSERVICE_DESCRIPTION = "WebserviceDescription"; // NOI18N
68 public static final String MESSAGE_DESTINATION_REF = "MessageDestinationRef"; // NOI18N
69
70         
71         /** Setter for error-url property
72          * @param value property value
73          */
74     public void setErrorUrl(java.lang.String value) throws VersionNotSupportedException;
75         /** Getter for error-url property.
76          * @return property value
77          */
78     public java.lang.String getErrorUrl() throws VersionNotSupportedException;
79         /** Setter for context-root property
80          * @param value property value
81          */
82     public void setContextRoot(String value);
83         /** Getter for context-root property.
84          * @return property value
85          */
86     public String getContextRoot();
87
88     public void setHttpservletSecurityProvider(java.lang.String value) throws VersionNotSupportedException;
89     public java.lang.String getHttpservletSecurityProvider() throws VersionNotSupportedException;
90     
91     public void setSecurityRoleMapping(int index, SecurityRoleMapping value);
92     public SecurityRoleMapping getSecurityRoleMapping(int index);
93     public int sizeSecurityRoleMapping();
94     public void setSecurityRoleMapping(SecurityRoleMapping[] value);
95     public SecurityRoleMapping[] getSecurityRoleMapping();
96     public int addSecurityRoleMapping(SecurityRoleMapping value);
97     public int removeSecurityRoleMapping(SecurityRoleMapping value);
98     public SecurityRoleMapping newSecurityRoleMapping();
99
100     public void setServlet(int index, Servlet value);
101     public Servlet getServlet(int index);
102     public int sizeServlet();
103     public void setServlet(Servlet[] value);
104     public Servlet[] getServlet();
105     public int addServlet(Servlet value);
106     public int removeServlet(Servlet value);
107     public Servlet newServlet();
108
109         public void setIdempotentUrlPattern(int index, boolean value) throws VersionNotSupportedException;
110         public boolean isIdempotentUrlPattern(int index) throws VersionNotSupportedException;
111         public int sizeIdempotentUrlPattern() throws VersionNotSupportedException;
112     public void setIdempotentUrlPattern(boolean[] value) throws VersionNotSupportedException;
113     public boolean[] getIdempotentUrlPattern() throws VersionNotSupportedException;
114     public int addIdempotentUrlPattern(boolean value) throws VersionNotSupportedException;
115     public int removeIdempotentUrlPattern(boolean value) throws VersionNotSupportedException;
116     public void removeIdempotentUrlPattern(int index) throws VersionNotSupportedException;
117         
118         /** Setter for url-pattern attribute of idempotent-url-pattern
119          * @param value attribute value
120          */
121     public void setIdempotentUrlPatternUrlPattern(int index, java.lang.String value) throws VersionNotSupportedException;
122         /** Getter for url-pattern attribute of idempotent-url-pattern
123          * @return attribute value
124          */
125     public java.lang.String getIdempotentUrlPatternUrlPattern(int index) throws VersionNotSupportedException;
126     public int sizeIdempotentUrlPatternUrlPattern() throws VersionNotSupportedException;
127     
128         /** Setter for num-of-retries attribute of idempotent-url-pattern
129          * @param value attribute value
130          */
131         public void setIdempotentUrlPatternNumOfRetries(int index, java.lang.String value) throws VersionNotSupportedException;
132         /** Getter for num-of-retries attribute of idempotent-url-pattern
133          * @return attribute value
134          */
135     public java.lang.String getIdempotentUrlPatternNumOfRetries(int index) throws VersionNotSupportedException;
136     public int sizeIdempotentUrlPatternNumOfRetries() throws VersionNotSupportedException;
137
138         /** Setter for session-config property
139          * @param value property value
140          */
141     public void setSessionConfig(SessionConfig value);
142         /** Getter for session-config property.
143          * @return property value
144          */
145     public SessionConfig getSessionConfig();
146
147     public SessionConfig newSessionConfig();
148
149     public void setEjbRef(int index, EjbRef value);
150     public EjbRef getEjbRef(int index);
151     public int sizeEjbRef();
152     public void setEjbRef(EjbRef[] value);
153     public EjbRef[] getEjbRef();
154     public int addEjbRef(EjbRef value);
155     public int removeEjbRef(EjbRef value);
156     public EjbRef newEjbRef();
157
158     public void setResourceRef(int index, ResourceRef value);
159     public ResourceRef getResourceRef(int index);
160     public int sizeResourceRef();
161     public void setResourceRef(ResourceRef[] value);
162     public ResourceRef[] getResourceRef();
163     public int addResourceRef(ResourceRef value);
164     public int removeResourceRef(ResourceRef value);
165     public ResourceRef newResourceRef();
166
167     public void setResourceEnvRef(int index, ResourceEnvRef value);
168     public ResourceEnvRef getResourceEnvRef(int index);
169     public int sizeResourceEnvRef();
170     public void setResourceEnvRef(ResourceEnvRef[] value);
171     public ResourceEnvRef[] getResourceEnvRef();
172     public int addResourceEnvRef(ResourceEnvRef value);
173     public int removeResourceEnvRef(ResourceEnvRef value);
174     public ResourceEnvRef newResourceEnvRef();
175
176     public void setServiceRef(int index, ServiceRef value);
177     public ServiceRef getServiceRef(int index);
178     public int sizeServiceRef();
179     public void setServiceRef(ServiceRef[] value);
180     public ServiceRef[] getServiceRef();
181     public int addServiceRef(ServiceRef value);
182     public int removeServiceRef(ServiceRef value);
183     public ServiceRef newServiceRef();
184
185         /** Setter for cache property
186          * @param value property value
187          */
188     public void setCache(Cache value);
189         /** Getter for cache property.
190          * @return property value
191          */
192     public Cache getCache();
193     public Cache newCache();
194
195         /** Setter for class-loader property in web_2_4-1
196          * @param value property value
197          */
198         public void setMyClassLoader(MyClassLoader value) throws VersionNotSupportedException;
199         /** Getter for class-loader property in web_2_4-1
200          * @return property value
201          */
202     public MyClassLoader getMyClassLoader() throws VersionNotSupportedException;
203
204     public MyClassLoader newMyClassLoader() throws VersionNotSupportedException;
205
206         /** Setter for class-loader property in web_2_4-0
207          * @param value property value
208          */
209         public void setMyClassLoader(boolean value) throws VersionNotSupportedException;
210     /** Getter for class-loader property. in web_2_4-0
211          * @return property value
212          */
213     public boolean isMyClassLoader() throws VersionNotSupportedException;
214         
215         /** Setter for jsp-config property
216          * @param value property value
217          */
218     public void setJspConfig(JspConfig value);
219         /** Getter for jsp-config property.
220          * @return property value
221          */
222     public JspConfig getJspConfig();
223
224     public JspConfig newJspConfig();
225
226         /** Setter for locale-charset-info property
227          * @param value property value
228          */
229     public void setLocaleCharsetInfo(LocaleCharsetInfo value);
230         /** Getter for locale-charset-info property.
231          * @return property value
232          */
233     public LocaleCharsetInfo getLocaleCharsetInfo();
234
235     public LocaleCharsetInfo newLocaleCharsetInfo();
236         
237         /** Setter for parameter-encoding property.
238          * @param value property value
239          */
240     public void setParameterEncoding(boolean value) throws VersionNotSupportedException;
241         /** Check for parameter-encoding property.
242          * @return property value
243          */
244     public boolean isParameterEncoding() throws VersionNotSupportedException;
245         /** Setter for form-hint-field attribute.
246          * @param value attribute value
247          */
248     public void setParameterEncodingFormHintField(java.lang.String value) throws VersionNotSupportedException;
249         /** Getter for form-hint-field attribute.
250          * @return attribute value
251          */
252     public java.lang.String getParameterEncodingFormHintField() throws VersionNotSupportedException;
253         /** Setter for default-charset attribute.
254          * @param value attribute value
255          */
256     public void setParameterEncodingDefaultCharset(java.lang.String value) throws VersionNotSupportedException;
257         /** Getter for default-charset attribute.
258          * @return attribute value
259          */
260     public java.lang.String getParameterEncodingDefaultCharset() throws VersionNotSupportedException;
261
262     public void setWebProperty(int index, WebProperty value);
263         public WebProperty getWebProperty(int index);
264     public int sizeWebProperty();
265     public void setWebProperty(WebProperty[] value);
266     public WebProperty[] getWebProperty();
267     public int addWebProperty(WebProperty value);
268     public int removeWebProperty(WebProperty value);
269     public WebProperty newWebProperty();
270
271     public void setMessageDestination(int index, MessageDestination value);
272     public MessageDestination getMessageDestination(int index);
273     public int sizeMessageDestination();
274     public void setMessageDestination(MessageDestination[] value);
275     public MessageDestination[] getMessageDestination();
276     public int addMessageDestination(MessageDestination value);
277     public int removeMessageDestination(MessageDestination value);
278     public MessageDestination newMessageDestination();
279
280     public void setWebserviceDescription(int index, WebserviceDescription value);
281     public WebserviceDescription getWebserviceDescription(int index);
282     public int sizeWebserviceDescription();
283     public void setWebserviceDescription(WebserviceDescription[] value);
284     public WebserviceDescription[] getWebserviceDescription();
285     public int addWebserviceDescription(WebserviceDescription value);
286     public int removeWebserviceDescription(WebserviceDescription value);
287     public WebserviceDescription newWebserviceDescription();
288
289         //Required for web 2.5.0
290 public void setMessageDestinationRef(int index, MessageDestinationRef value) throws VersionNotSupportedException;
291         public MessageDestinationRef getMessageDestinationRef(int index) throws VersionNotSupportedException;
292         public int sizeMessageDestinationRef() throws VersionNotSupportedException;
293         public void setMessageDestinationRef(MessageDestinationRef[] value) throws VersionNotSupportedException;
294         public MessageDestinationRef[] getMessageDestinationRef() throws VersionNotSupportedException;
295         public int addMessageDestinationRef(MessageDestinationRef value) throws VersionNotSupportedException;
296         public int removeMessageDestinationRef(MessageDestinationRef value) throws VersionNotSupportedException;
297         public MessageDestinationRef newMessageDestinationRef() throws VersionNotSupportedException;
298 }
299

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags