com.sun.grizzly.http.webxml.schema.version_2_4
Class ServletType

java.lang.Object
  extended by com.sun.grizzly.http.webxml.schema.version_2_4.ServletType

public class ServletType
extends Object

The servletType is used to declare a servlet. It contains the declarative data of a servlet. If a jsp-file is specified and the load-on-startup element is present, then the JSP should be precompiled and loaded. Used in: web-app

Java class for servletType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="servletType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/j2ee}descriptionGroup"/>
         <element name="servlet-name" type="{http://java.sun.com/xml/ns/j2ee}servlet-nameType"/>
         <choice>
           <element name="servlet-class" type="{http://java.sun.com/xml/ns/j2ee}fully-qualified-classType"/>
           <element name="jsp-file" type="{http://java.sun.com/xml/ns/j2ee}jsp-fileType"/>
         </choice>
         <element name="init-param" type="{http://java.sun.com/xml/ns/j2ee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="load-on-startup" type="{http://java.sun.com/xml/ns/j2ee}xsdIntegerType" minOccurs="0"/>
         <element name="run-as" type="{http://java.sun.com/xml/ns/j2ee}run-asType" minOccurs="0"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/j2ee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  List<DescriptionType> description
           
protected  List<DisplayNameType> displayName
           
protected  List<IconType> icon
           
protected  String id
           
protected  List<ParamValueType> initParam
           
protected  JspFileType jspFile
           
protected  XsdIntegerType loadOnStartup
           
protected  RunAsType runAs
           
protected  List<SecurityRoleRefType> securityRoleRef
           
protected  FullyQualifiedClassType servletClass
           
protected  ServletNameType servletName
           
 
Constructor Summary
ServletType()
           
 
Method Summary
 List<DescriptionType> getDescription()
          Gets the value of the description property.
 List<DisplayNameType> getDisplayName()
          Gets the value of the displayName property.
 List<IconType> getIcon()
          Gets the value of the icon property.
 String getId()
          Gets the value of the id property.
 List<ParamValueType> getInitParam()
          Gets the value of the initParam property.
 JspFileType getJspFile()
          Gets the value of the jspFile property.
 XsdIntegerType getLoadOnStartup()
          Gets the value of the loadOnStartup property.
 RunAsType getRunAs()
          Gets the value of the runAs property.
 List<SecurityRoleRefType> getSecurityRoleRef()
          Gets the value of the securityRoleRef property.
 FullyQualifiedClassType getServletClass()
          Gets the value of the servletClass property.
 ServletNameType getServletName()
          Gets the value of the servletName property.
 void setId(String value)
          Sets the value of the id property.
 void setJspFile(JspFileType value)
          Sets the value of the jspFile property.
 void setLoadOnStartup(XsdIntegerType value)
          Sets the value of the loadOnStartup property.
 void setRunAs(RunAsType value)
          Sets the value of the runAs property.
 void setServletClass(FullyQualifiedClassType value)
          Sets the value of the servletClass property.
 void setServletName(ServletNameType value)
          Sets the value of the servletName property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

description

protected List<DescriptionType> description

displayName

protected List<DisplayNameType> displayName

icon

protected List<IconType> icon

servletName

protected ServletNameType servletName

servletClass

protected FullyQualifiedClassType servletClass

jspFile

protected JspFileType jspFile

initParam

protected List<ParamValueType> initParam

loadOnStartup

protected XsdIntegerType loadOnStartup

runAs

protected RunAsType runAs

securityRoleRef

protected List<SecurityRoleRefType> securityRoleRef

id

protected String id
Constructor Detail

ServletType

public ServletType()
Method Detail

getDescription

public List<DescriptionType> getDescription()
Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType


getDisplayName

public List<DisplayNameType> getDisplayName()
Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list DisplayNameType


getIcon

public List<IconType> getIcon()
Gets the value of the icon property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the icon property.

For example, to add a new item, do as follows:

    getIcon().add(newItem);
 

Objects of the following type(s) are allowed in the list IconType


getServletName

public ServletNameType getServletName()
Gets the value of the servletName property.

Returns:
possible object is ServletNameType

setServletName

public void setServletName(ServletNameType value)
Sets the value of the servletName property.

Parameters:
value - allowed object is ServletNameType

getServletClass

public FullyQualifiedClassType getServletClass()
Gets the value of the servletClass property.

Returns:
possible object is FullyQualifiedClassType

setServletClass

public void setServletClass(FullyQualifiedClassType value)
Sets the value of the servletClass property.

Parameters:
value - allowed object is FullyQualifiedClassType

getJspFile

public JspFileType getJspFile()
Gets the value of the jspFile property.

Returns:
possible object is JspFileType

setJspFile

public void setJspFile(JspFileType value)
Sets the value of the jspFile property.

Parameters:
value - allowed object is JspFileType

getInitParam

public List<ParamValueType> getInitParam()
Gets the value of the initParam property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParam property.

For example, to add a new item, do as follows:

    getInitParam().add(newItem);
 

Objects of the following type(s) are allowed in the list ParamValueType


getLoadOnStartup

public XsdIntegerType getLoadOnStartup()
Gets the value of the loadOnStartup property.

Returns:
possible object is XsdIntegerType

setLoadOnStartup

public void setLoadOnStartup(XsdIntegerType value)
Sets the value of the loadOnStartup property.

Parameters:
value - allowed object is XsdIntegerType

getRunAs

public RunAsType getRunAs()
Gets the value of the runAs property.

Returns:
possible object is RunAsType

setRunAs

public void setRunAs(RunAsType value)
Sets the value of the runAs property.

Parameters:
value - allowed object is RunAsType

getSecurityRoleRef

public List<SecurityRoleRefType> getSecurityRoleRef()
Gets the value of the securityRoleRef property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the securityRoleRef property.

For example, to add a new item, do as follows:

    getSecurityRoleRef().add(newItem);
 

Objects of the following type(s) are allowed in the list SecurityRoleRefType


getId

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String


Copyright © 2012 Oracle Corporation. All Rights Reserved.