Top Description Fields Constructors Methods
org.apache.tomcat.util.descriptor.web

public Class ServletDef

extends Object
implements Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable
Imports
java.io.Serializable, java.util.HashMap, .HashSet, .Map, .Set, org.apache.tomcat.util.res.StringManager

Representation of a servlet definition for a web application, as represented in a <servlet> element in the deployment descriptor.

Field Summary

Modifier and TypeField and Description
private Boolean
asyncSupported

Does this servlet support async.

private String
description

The description of this servlet.

private String
displayName

The display name of this servlet.

private Boolean
enabled

Is this servlet enabled.

private String
jspFile

The name of the JSP file to which this servlet definition applies

private String
largeIcon

The large icon associated with this servlet.

private Integer
loadOnStartup

The load-on-startup order for this servlet

private MultipartDef
multipartDef

The multipart configuration, if any, for this servlet

private boolean
overridable

Can this ServletDef be overridden by an SCI?

private final Map<String, String>
parameters

The set of initialization parameters for this servlet, keyed by parameter name.

private String
runAs

The run-as configuration for this servlet

private final Set<SecurityRoleRef>
securityRoleRefs

The set of security role references for this servlet

private static final long
private String
servletClass

The fully qualified name of the Java class that implements this servlet.

private String
servletName

The name of this servlet, which must be unique among the servlets defined for a particular web application.

private static final StringManager
private String
smallIcon

The small icon associated with this servlet.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public void
addInitParameter(String
The initialisation parameter name
name
,
String
The initialisation parameter value
value
)

Add an initialization parameter to the set of parameters associated with this servlet.

public void
addSecurityRoleRef(SecurityRoleRef
The security role
securityRoleRef
)

Add a security-role-ref to the set of security-role-refs associated with this servlet.

public Boolean
public String
public String
public Boolean
public String
public String
public Integer
public MultipartDef
public Map<String, String>
public String
public Set<SecurityRoleRef>
public String
public String
public String
public boolean
public void
setAsyncSupported(String asyncSupported)

public void
setDescription(String description)

public void
setDisplayName(String displayName)

public void
setEnabled(String enabled)

public void
setJspFile(String jspFile)

public void
setLargeIcon(String largeIcon)

public void
setLoadOnStartup(String loadOnStartup)

public void
public void
setOverridable(boolean overridable)

public void
public void
setServletClass(String servletClass)

public void
setServletName(String servletName)

public void
setSmallIcon(String smallIcon)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

asyncSupportedback to summary
private Boolean asyncSupported

Does this servlet support async.

descriptionback to summary
private String description

The description of this servlet.

displayNameback to summary
private String displayName

The display name of this servlet.

enabledback to summary
private Boolean enabled

Is this servlet enabled.

jspFileback to summary
private String jspFile

The name of the JSP file to which this servlet definition applies

largeIconback to summary
private String largeIcon

The large icon associated with this servlet.

loadOnStartupback to summary
private Integer loadOnStartup

The load-on-startup order for this servlet

multipartDefback to summary
private MultipartDef multipartDef

The multipart configuration, if any, for this servlet

overridableback to summary
private boolean overridable

Can this ServletDef be overridden by an SCI?

parametersback to summary
private final Map<String, String> parameters

The set of initialization parameters for this servlet, keyed by parameter name.

runAsback to summary
private String runAs

The run-as configuration for this servlet

securityRoleRefsback to summary
private final Set<SecurityRoleRef> securityRoleRefs

The set of security role references for this servlet

serialVersionUIDback to summary
private static final long serialVersionUID
servletClassback to summary
private String servletClass

The fully qualified name of the Java class that implements this servlet.

servletNameback to summary
private String servletName

The name of this servlet, which must be unique among the servlets defined for a particular web application.

smback to summary
private static final StringManager sm
smallIconback to summary
private String smallIcon

The small icon associated with this servlet.

Constructor Detail

ServletDefback to summary
public ServletDef()

Method Detail

addInitParameterback to summary
public void addInitParameter(String name, String value)

Add an initialization parameter to the set of parameters associated with this servlet.

Parameters
name:String

The initialisation parameter name

value:String

The initialisation parameter value

addSecurityRoleRefback to summary
public void addSecurityRoleRef(SecurityRoleRef securityRoleRef)

Add a security-role-ref to the set of security-role-refs associated with this servlet.

Parameters
securityRoleRef:SecurityRoleRef

The security role

getAsyncSupportedback to summary
public Boolean getAsyncSupported()
getDescriptionback to summary
public String getDescription()
getDisplayNameback to summary
public String getDisplayName()
getEnabledback to summary
public Boolean getEnabled()
getJspFileback to summary
public String getJspFile()
getLargeIconback to summary
public String getLargeIcon()
getLoadOnStartupback to summary
public Integer getLoadOnStartup()
getMultipartDefback to summary
public MultipartDef getMultipartDef()
getParameterMapback to summary
public Map<String, String> getParameterMap()
getRunAsback to summary
public String getRunAs()
getSecurityRoleRefsback to summary
public Set<SecurityRoleRef> getSecurityRoleRefs()
getServletClassback to summary
public String getServletClass()
getServletNameback to summary
public String getServletName()
getSmallIconback to summary
public String getSmallIcon()
isOverridableback to summary
public boolean isOverridable()
setAsyncSupportedback to summary
public void setAsyncSupported(String asyncSupported)
setDescriptionback to summary
public void setDescription(String description)
setDisplayNameback to summary
public void setDisplayName(String displayName)
setEnabledback to summary
public void setEnabled(String enabled)
setJspFileback to summary
public void setJspFile(String jspFile)
setLargeIconback to summary
public void setLargeIcon(String largeIcon)
setLoadOnStartupback to summary
public void setLoadOnStartup(String loadOnStartup)
setMultipartDefback to summary
public void setMultipartDef(MultipartDef multipartDef)
setOverridableback to summary
public void setOverridable(boolean overridable)
setRunAsback to summary
public void setRunAs(String runAs)
setServletClassback to summary
public void setServletClass(String servletClass)
setServletNameback to summary
public void setServletName(String servletName)
setSmallIconback to summary
public void setSmallIcon(String smallIcon)