KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > web > dd > Servlet


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 /**
22  * Generated interface for Servlet element.
23  *
24  *<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>
25  *</p>
26  * @deprecated Use the API for web module deployment descriptor in j2ee/ddapi module.
27  */

28
29 public interface Servlet extends org.netbeans.api.web.dd.common.ComponentInterface {
30         /** Setter for servlet-name property.
31          * @param value property value
32          */

33     public void setServletName(java.lang.String JavaDoc value);
34         /** Getter for servlet-name property.
35          * @return property value
36          */

37     public java.lang.String JavaDoc getServletName();
38         /** Setter for servlet-class property.
39          * @param value property value
40          */

41     public void setServletClass(java.lang.String JavaDoc value);
42         /** Getter for servlet-class property.
43          * @return property value
44          */

45     public java.lang.String JavaDoc getServletClass();
46         /** Setter for jsp-file property.
47          * @param value property value
48          */

49     public void setJspFile(java.lang.String JavaDoc value);
50         /** Getter for jsp-file property.
51          * @return property value
52          */

53     public java.lang.String JavaDoc getJspFile();
54         /** Setter for init-param element.
55          * @param index position in the array of elements
56          * @param valueInterface init-param element (InitParam object)
57          */

58     public void setInitParam(int index, org.netbeans.api.web.dd.InitParam valueInterface);
59         /** Getter for init-param element.
60          * @param index position in the array of elements
61          * @return init-param element (InitParam object)
62          */

63     public org.netbeans.api.web.dd.InitParam getInitParam(int index);
64         /** Setter for init-param elements.
65          * @param value array of init-param elements (InitParam objects)
66          */

67     public void setInitParam(org.netbeans.api.web.dd.InitParam[] value);
68         /** Getter for init-param elements.
69          * @return array of init-param elements (InitParam objects)
70          */

71     public org.netbeans.api.web.dd.InitParam[] getInitParam();
72         /** Returns size of init-param elements.
73          * @return number of init-param elements
74          */

75     public int sizeInitParam();
76         /** Adds init-param element.
77          * @param valueInterface init-param element (InitParam object)
78          * @return index of new init-param
79          */

80     public int addInitParam(org.netbeans.api.web.dd.InitParam valueInterface);
81         /** Removes init-param element.
82          * @param valueInterface init-param element (InitParam object)
83          * @return index of the removed init-param
84          */

85     public int removeInitParam(org.netbeans.api.web.dd.InitParam valueInterface);
86         /** Setter for load-on-startup property.
87          * @param value property value
88          */

89     public void setLoadOnStartup(java.math.BigInteger JavaDoc value);
90         /** Getter for load-on-startup property.
91          * @return property value
92          */

93     public java.math.BigInteger JavaDoc getLoadOnStartup();
94         /** Setter for run-as element.
95          * @param valueInterface run-as element (RunAs object)
96          */

97     public void setRunAs(org.netbeans.api.web.dd.RunAs valueInterface);
98         /** Getter for run-as element.
99          * @return run-as element (RunAs object)
100          */

101     public org.netbeans.api.web.dd.RunAs getRunAs();
102         /** Setter for security-role-ref element.
103          * @param index position in the array of elements
104          * @param valueInterface security-role-ref element (SecurityRoleRef object)
105          */

106     public void setSecurityRoleRef(int index, org.netbeans.api.web.dd.SecurityRoleRef valueInterface);
107         /** Getter for security-role-ref element.
108          * @param index position in the array of elements
109          * @return security-role-ref element (SecurityRoleRef object)
110          */

111     public org.netbeans.api.web.dd.SecurityRoleRef getSecurityRoleRef(int index);
112         /** Setter for security-role-ref elements.
113          * @param value array of security-role-ref elements (SecurityRoleRef objects)
114          */

115     public void setSecurityRoleRef(org.netbeans.api.web.dd.SecurityRoleRef[] value);
116         /** Getter for security-role-ref elements.
117          * @return array of security-role-ref elements (SecurityRoleRef objects)
118          */

119     public org.netbeans.api.web.dd.SecurityRoleRef[] getSecurityRoleRef();
120         /** Returns size of security-role-ref elements.
121          * @return number of security-role-ref elements
122          */

123     public int sizeSecurityRoleRef();
124         /** Adds security-role-ref element.
125          * @param valueInterface security-role-ref element (SecurityRoleRef object)
126          * @return index of new security-role-ref
127          */

128     public int addSecurityRoleRef(org.netbeans.api.web.dd.SecurityRoleRef valueInterface);
129         /** Removes security-role-ref element.
130          * @param valueInterface security-role-ref element (SecurityRoleRef object)
131          * @return index of the removed security-role-ref
132          */

133     public int removeSecurityRoleRef(org.netbeans.api.web.dd.SecurityRoleRef valueInterface);
134
135 }
136
Popular Tags