com.sun.java.xml.ns.javaee

Class ServletType

java.lang.Object

com.sun.java.xml.ns.javaee.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/javaee}descriptionGroup"/>
         <element name="servlet-name" type="{http://java.sun.com/xml/ns/javaee}servlet-nameType"/>
         <choice minOccurs="0">
           <element name="servlet-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
           <element name="jsp-file" type="{http://java.sun.com/xml/ns/javaee}jsp-fileType"/>
         </choice>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="load-on-startup" type="{http://java.sun.com/xml/ns/javaee}load-on-startupType" minOccurs="0"/>
         <element name="enabled" type="{http://java.sun.com/xml/ns/javaee}true-falseType" minOccurs="0"/>
         <element name="async-supported" type="{http://java.sun.com/xml/ns/javaee}true-falseType" minOccurs="0"/>
         <element name="run-as" type="{http://java.sun.com/xml/ns/javaee}run-asType" minOccurs="0"/>
         <element name="security-role-ref" type="{http://java.sun.com/xml/ns/javaee}security-role-refType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="multipart-config" type="{http://java.sun.com/xml/ns/javaee}multipart-configType" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected TrueFalseType	asyncSupported
protected List<DescriptionType>	description
protected List<DisplayNameType>	displayName
protected TrueFalseType	enabled
protected List<IconType>	icon
protected String	id
protected List<ParamValueType>	initParam
protected JspFileType	jspFile
protected String	loadOnStartup
protected MultipartConfigType	multipartConfig
protected RunAsType	runAs
protected List<SecurityRoleRefType>	securityRoleRef
protected FullyQualifiedClassType	servletClass
protected ServletNameType	servletName

Constructor Summary

Constructors

Constructor and Description
ServletType()

Method Summary

Modifier and Type	Method and Description
TrueFalseType	getAsyncSupported() Gets the value of the asyncSupported property.
List<DescriptionType>	getDescription() Gets the value of the description property.
List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
TrueFalseType	getEnabled() Gets the value of the enabled 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.
String	getLoadOnStartup() Gets the value of the loadOnStartup property.
MultipartConfigType	getMultipartConfig() Gets the value of the multipartConfig 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	setAsyncSupported(TrueFalseType value) Sets the value of the asyncSupported property.
void	setEnabled(TrueFalseType value) Sets the value of the enabled 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(String value) Sets the value of the loadOnStartup property.
void	setMultipartConfig(MultipartConfigType value) Sets the value of the multipartConfig 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.
ServletType	withAsyncSupported(TrueFalseType value)
ServletType	withDescription(Collection<DescriptionType> values)
ServletType	withDescription(DescriptionType... values)
ServletType	withDisplayName(Collection<DisplayNameType> values)
ServletType	withDisplayName(DisplayNameType... values)
ServletType	withEnabled(TrueFalseType value)
ServletType	withIcon(Collection<IconType> values)
ServletType	withIcon(IconType... values)
ServletType	withId(String value)
ServletType	withInitParam(Collection<ParamValueType> values)
ServletType	withInitParam(ParamValueType... values)
ServletType	withJspFile(JspFileType value)
ServletType	withLoadOnStartup(String value)
ServletType	withMultipartConfig(MultipartConfigType value)
ServletType	withRunAs(RunAsType value)
ServletType	withSecurityRoleRef(Collection<SecurityRoleRefType> values)
ServletType	withSecurityRoleRef(SecurityRoleRefType... values)
ServletType	withServletClass(FullyQualifiedClassType value)
ServletType	withServletName(ServletNameType value)

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 String loadOnStartup

enabled

protected TrueFalseType enabled

asyncSupported

protected TrueFalseType asyncSupported

runAs

protected RunAsType runAs

securityRoleRef

protected List<SecurityRoleRefType> securityRoleRef

multipartConfig

protected MultipartConfigType multipartConfig

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 String getLoadOnStartup()

Gets the value of the loadOnStartup property.

Returns:

possible object is String

setLoadOnStartup

public void setLoadOnStartup(String value)

Sets the value of the loadOnStartup property.

Parameters:

value - allowed object is String

getEnabled

public TrueFalseType getEnabled()

Gets the value of the enabled property.

Returns:

possible object is TrueFalseType

setEnabled

public void setEnabled(TrueFalseType value)

Sets the value of the enabled property.

Parameters:

value - allowed object is TrueFalseType

getAsyncSupported

public TrueFalseType getAsyncSupported()

Gets the value of the asyncSupported property.

Returns:

possible object is TrueFalseType

setAsyncSupported

public void setAsyncSupported(TrueFalseType value)

Sets the value of the asyncSupported property.

Parameters:

value - allowed object is TrueFalseType

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

getMultipartConfig

public MultipartConfigType getMultipartConfig()

Gets the value of the multipartConfig property.

Returns:

possible object is MultipartConfigType

setMultipartConfig

public void setMultipartConfig(MultipartConfigType value)

Sets the value of the multipartConfig property.

Parameters:

value - allowed object is MultipartConfigType

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

withDescription

public ServletType withDescription(DescriptionType... values)

withDescription

public ServletType withDescription(Collection<DescriptionType> values)

withDisplayName

public ServletType withDisplayName(DisplayNameType... values)

withDisplayName

public ServletType withDisplayName(Collection<DisplayNameType> values)

withIcon

public ServletType withIcon(IconType... values)

withIcon

public ServletType withIcon(Collection<IconType> values)

withServletName

public ServletType withServletName(ServletNameType value)

withServletClass

public ServletType withServletClass(FullyQualifiedClassType value)

withJspFile

public ServletType withJspFile(JspFileType value)

withInitParam

public ServletType withInitParam(ParamValueType... values)

withInitParam

public ServletType withInitParam(Collection<ParamValueType> values)

withLoadOnStartup

public ServletType withLoadOnStartup(String value)

withEnabled

public ServletType withEnabled(TrueFalseType value)

withAsyncSupported

public ServletType withAsyncSupported(TrueFalseType value)

withRunAs

public ServletType withRunAs(RunAsType value)

withSecurityRoleRef

public ServletType withSecurityRoleRef(SecurityRoleRefType... values)

withSecurityRoleRef

public ServletType withSecurityRoleRef(Collection<SecurityRoleRefType> values)

withMultipartConfig

public ServletType withMultipartConfig(MultipartConfigType value)

withId

public ServletType withId(String value)