org.eclipse.jst.j2ee.webapplication
Interface Servlet

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject

public interface Servlet
extends CompatibilityDescriptionGroup

The servlet element 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.

Since:
1.0

Method Summary
 EList getInitParams()
          Returns the value of the 'Init Params' containment reference list.
 java.lang.Integer getLoadOnStartup()
           
 java.util.List getMappings()
          Returns an unmodifiable list of the mappings that this servlet participates in.
 EList getParams()
           
 java.util.Properties getParamsAsProperties()
          Gets the Servlet parameters in java.util.Properties
 RunAsSpecifiedIdentity getRunAs()
           
 EList getSecurityRoleRefs()
           
 JavaClass getServletClass()
          return the java servlet class associated with this servlet
 java.lang.String getServletName()
           
 WebApp getWebApp()
           
 WebType getWebType()
           
 boolean isSetLoadOnStartup()
          Returns whether the value of the 'Load On Startup' attribute is set
 void reSyncSecurityRoleRef(java.lang.String existingRoleName, java.lang.String newRoleName)
          Fix the role-link on any contained role refs
 void setLoadOnStartup(java.lang.Integer value)
          Sets the value of the 'Load On Startup' attribute
 void setRunAs(RunAsSpecifiedIdentity value)
           
 void setServletName(java.lang.String value)
           
 void setWebApp(WebApp value)
           
 void setWebType(WebType value)
           
 void unsetLoadOnStartup()
          Unsets the value of the 'Load On Startup' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.common.CompatibilityDescriptionGroup
getDescription, getDisplayName, getLargeIcon, getSmallIcon, setDescription, setDescriptionGen, setDisplayName, setDisplayNameGen, setLargeIcon, setLargeIconGen, setSmallIcon, setSmallIconGen
 
Methods inherited from interface org.eclipse.jst.j2ee.common.DescriptionGroup
getDescriptions, getDisplayNames, getIcons
 

Method Detail

getMappings

public java.util.List getMappings()
Returns an unmodifiable list of the mappings that this servlet participates in. Since servletMappings is not a bi-directional attribute, if you want to add or delete a mapping, this must be done in the web-app.

Returns:
java.util.List

getParamsAsProperties

public java.util.Properties getParamsAsProperties()
Gets the Servlet parameters in java.util.Properties

Returns:
java.util.Properties

reSyncSecurityRoleRef

public void reSyncSecurityRoleRef(java.lang.String existingRoleName,
                                  java.lang.String newRoleName)
Fix the role-link on any contained role refs

Parameters:
existingRoleName - existing role name
newRoleName - new role name

getServletName

public java.lang.String getServletName()
Returns:
The value of the ServletName attribute The servlet-name element contains the canonical name of the servlet.

setServletName

public void setServletName(java.lang.String value)
Parameters:
value - The new value of the ServletName attribute

getLoadOnStartup

public java.lang.Integer getLoadOnStartup()
Returns:
The value of the LoadOnStartup attribute The load-on-startup element indicates that this servlet should be loaded on the startup of the web application. The optional contents of these element must be a positive integer indicating the order in which the servlet should be loaded. Lower integers are loaded before higher integers. If no value is specified, or if the value specified is not a positive integer, the container is free to load it at any time in the startup sequence.

setLoadOnStartup

public void setLoadOnStartup(java.lang.Integer value)
Sets the value of the 'Load On Startup' attribute.

Parameters:
value - the new value of the 'Load On Startup' attribute.
See Also:
isSetLoadOnStartup(), unsetLoadOnStartup(), getLoadOnStartup()

unsetLoadOnStartup

public void unsetLoadOnStartup()
Unsets the value of the 'Load On Startup' attribute.

See Also:
isSetLoadOnStartup(), getLoadOnStartup(), setLoadOnStartup(Integer)

isSetLoadOnStartup

public boolean isSetLoadOnStartup()
Returns whether the value of the 'Load On Startup' attribute is set.

Returns:
whether the value of the 'Load On Startup' attribute is set.
See Also:
unsetLoadOnStartup(), getLoadOnStartup(), setLoadOnStartup(Integer)

getWebApp

public WebApp getWebApp()
Returns:
The WebApp reference

setWebApp

public void setWebApp(WebApp value)
Parameters:
value - The new value of the WebApp reference

getWebType

public WebType getWebType()
Returns:
The WebType reference

setWebType

public void setWebType(WebType value)
Parameters:
value - The new value of the WebType reference

getParams

public EList getParams()
Returns:
The list of Params references

getSecurityRoleRefs

public EList getSecurityRoleRefs()
Returns:
The list of SecurityRoleRefs references

getRunAs

public RunAsSpecifiedIdentity getRunAs()
Returns:
The RunAs reference If defined for a servlet, overrides the security identity used to call an EJB by that servlet in this web application. The role-name is one of the security roles already defined for this web application.

setRunAs

public void setRunAs(RunAsSpecifiedIdentity value)
Parameters:
value - The new value of the RunAs reference

getInitParams

public EList getInitParams()
Returns the value of the 'Init Params' containment reference list. The list contents are of type ParamValue.

If the meaning of the 'Init Params' containment reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Init Params' containment reference list.
See Also:
WebapplicationPackage.getServlet_InitParams()

getServletClass

public JavaClass getServletClass()
return the java servlet class associated with this servlet

Returns:
reference to JavaClass