|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ServletType<T>
This interface defines the contract for the servletType xsd type
Original Documentation:
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
| Method Summary | |
|---|---|
java.util.List<java.lang.String> |
getDescriptionList()
Returns all description elements |
java.util.List<java.lang.String> |
getDisplayNameList()
Returns all display-name elements |
java.util.List<IconType<ServletType<T>>> |
getIconList()
Returns all icon elements |
java.util.List<ParamValueType<ServletType<T>>> |
getInitParamList()
Returns all init-param elements |
java.lang.String |
getJspFile()
Returns the jsp-file element |
java.lang.Integer |
getLoadOnStartup()
Returns the load-on-startup element |
java.util.List<SecurityRoleRefType<ServletType<T>>> |
getSecurityRoleRefList()
Returns all security-role-ref elements |
java.lang.String |
getServletClass()
Returns the servlet-class element |
java.lang.String |
getServletName()
Returns the servlet-name element |
IconType<ServletType<T>> |
icon()
Returns the icon element |
ParamValueType<ServletType<T>> |
initParam()
Returns the init-param element |
java.lang.Boolean |
isAsyncSupported()
Returns the async-supported element |
java.lang.Boolean |
isEnabled()
Returns the enabled element |
MultipartConfigType<ServletType<T>> |
multipartConfig()
If not already created, a new multipart-config element will be created and returned. |
ServletType<T> |
removeAllDescription()
Removes the description element |
ServletType<T> |
removeAllDisplayName()
Removes the display-name element |
ServletType<T> |
removeAllIcon()
Removes all icon elements |
ServletType<T> |
removeAllInitParam()
Removes all init-param elements |
ServletType<T> |
removeAllSecurityRoleRef()
Removes all security-role-ref elements |
ServletType<T> |
removeAsyncSupported()
Removes the async-supported element |
ServletType<T> |
removeEnabled()
Removes the enabled element |
ServletType<T> |
removeJspFile()
Removes the jsp-file element |
ServletType<T> |
removeLoadOnStartup()
Removes the load-on-startup element |
ServletType<T> |
removeMultipartConfig()
Removes the multipart-config element |
ServletType<T> |
removeRunAs()
Removes the run-as element |
ServletType<T> |
removeServletClass()
Removes the servlet-class element |
ServletType<T> |
removeServletName()
Removes the servlet-name element |
RunAsType<ServletType<T>> |
runAs()
If not already created, a new run-as element will be created and returned. |
SecurityRoleRefType<ServletType<T>> |
securityRoleRef()
Returns the security-role-ref element |
ServletType<T> |
setAsyncSupported(java.lang.Boolean asyncSupported)
If not already created, a new async-supported element with the given value will be created. |
ServletType<T> |
setDescription(java.lang.String description)
Creates a new description element |
ServletType<T> |
setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements,
a new description element |
ServletType<T> |
setDisplayName(java.lang.String displayName)
Creates a new display-name element |
ServletType<T> |
setDisplayNameList(java.lang.String... values)
Creates for all String objects representing display-name elements,
a new display-name element |
ServletType<T> |
setEnabled(java.lang.Boolean enabled)
If not already created, a new enabled element with the given value will be created. |
ServletType<T> |
setJspFile(java.lang.String jspFile)
If not already created, a new jsp-file element with the given value will be created. |
ServletType<T> |
setLoadOnStartup(java.lang.Integer loadOnStartup)
If not already created, a new load-on-startup element with the given value will be created. |
ServletType<T> |
setServletClass(java.lang.String servletClass)
If not already created, a new servlet-class element with the given value will be created. |
ServletType<T> |
setServletName(java.lang.String servletName)
If not already created, a new servlet-name element with the given value will be created. |
| Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child |
|---|
up |
| Method Detail |
|---|
ServletType<T> setDescription(java.lang.String description)
description element
ServletTypeServletType<T> setDescriptionList(java.lang.String... values)
description elements,
a new description element
list - of description objects
ServletTypeServletType<T> removeAllDescription()
description element
ServletTypejava.util.List<java.lang.String> getDescriptionList()
description elements
descriptionServletType<T> setDisplayName(java.lang.String displayName)
display-name element
ServletTypeServletType<T> setDisplayNameList(java.lang.String... values)
display-name elements,
a new display-name element
list - of display-name objects
ServletTypeServletType<T> removeAllDisplayName()
display-name element
ServletTypejava.util.List<java.lang.String> getDisplayNameList()
display-name elements
display-nameServletType<T> removeAllIcon()
icon elements
ServletTypeIconType<ServletType<T>> icon()
icon element
iconjava.util.List<IconType<ServletType<T>>> getIconList()
icon elements
iconServletType<T> setServletName(java.lang.String servletName)
servlet-name element with the given value will be created.
Otherwise, the existing servlet-name element will be updated with the given value.
ServletTypeServletType<T> removeServletName()
servlet-name element
ServletTypejava.lang.String getServletName()
servlet-name element
servlet-nameServletType<T> removeAllInitParam()
init-param elements
ServletTypeParamValueType<ServletType<T>> initParam()
init-param element
init-paramjava.util.List<ParamValueType<ServletType<T>>> getInitParamList()
init-param elements
init-paramServletType<T> setLoadOnStartup(java.lang.Integer loadOnStartup)
load-on-startup element with the given value will be created.
Otherwise, the existing load-on-startup element will be updated with the given value.
ServletTypeServletType<T> removeLoadOnStartup()
load-on-startup element
ServletTypejava.lang.Integer getLoadOnStartup()
load-on-startup element
load-on-startupServletType<T> setEnabled(java.lang.Boolean enabled)
enabled element with the given value will be created.
Otherwise, the existing enabled element will be updated with the given value.
ServletTypeServletType<T> removeEnabled()
enabled element
ServletTypejava.lang.Boolean isEnabled()
enabled element
enabledServletType<T> setAsyncSupported(java.lang.Boolean asyncSupported)
async-supported element with the given value will be created.
Otherwise, the existing async-supported element will be updated with the given value.
ServletTypeServletType<T> removeAsyncSupported()
async-supported element
ServletTypejava.lang.Boolean isAsyncSupported()
async-supported element
async-supportedServletType<T> removeRunAs()
run-as element
ServletTypeRunAsType<ServletType<T>> runAs()
run-as element will be created and returned.
Otherwise, the existing run-as element will be returned.
run-asServletType<T> removeAllSecurityRoleRef()
security-role-ref elements
ServletTypeSecurityRoleRefType<ServletType<T>> securityRoleRef()
security-role-ref element
security-role-refjava.util.List<SecurityRoleRefType<ServletType<T>>> getSecurityRoleRefList()
security-role-ref elements
security-role-refServletType<T> removeMultipartConfig()
multipart-config element
ServletTypeMultipartConfigType<ServletType<T>> multipartConfig()
multipart-config element will be created and returned.
Otherwise, the existing multipart-config element will be returned.
multipart-configServletType<T> setServletClass(java.lang.String servletClass)
servlet-class element with the given value will be created.
Otherwise, the existing servlet-class element will be updated with the given value.
ServletTypeServletType<T> removeServletClass()
servlet-class element
ServletTypejava.lang.String getServletClass()
servlet-class element
servlet-classServletType<T> setJspFile(java.lang.String jspFile)
jsp-file element with the given value will be created.
Otherwise, the existing jsp-file element will be updated with the given value.
ServletTypeServletType<T> removeJspFile()
jsp-file element
ServletTypejava.lang.String getJspFile()
jsp-file element
jsp-file
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||