org.eclipse.jst.j2ee.webapplication
Interface WebApp

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, J2EEEObject, JNDIEnvRefsGroup

public interface WebApp
extends JNDIEnvRefsGroup

The web-app element is the root of the deployment descriptor for a web application.

Since:
1.0

Method Summary
 boolean containsSecurityRole(java.lang.String name)
          Returns true if there is a SecurityRole with the name passed
 EList getConstraints()
           
 EList getContextParams()
          Returns the value of the 'Context Params' containment reference list.
 EList getContexts()
           
 EList getEnvEntries()
          Deprecated. : Use getEnvironmentProperties()
 ErrorPage getErrorPageByCode(java.lang.Integer code)
          Returns an ErrorPage if it has the specified error code
 ErrorPage getErrorPageByExceptionType(java.lang.String exceptionType)
          Returns an ErrorPage given an exceptionType
 EList getErrorPages()
           
 WelcomeFileList getFileList()
           
 FilterMapping getFilterMapping(Filter aFilter)
          Finds a filter mapping for a specified filter.
 EList getFilterMappings()
           
 Filter getFilterNamed(java.lang.String name)
          Gets refernce to the instance of Filter which has the specified name
 java.util.List getFilterNames()
          Gets the names of the filters defined for this web application.
 EList getFilters()
           
 int getJ2EEVersionID()
          This returns the j2ee version id.
 JSPConfig getJspConfig()
          Returns the value of the 'Jsp Config' containment reference
 EList getListeners()
           
 LocalEncodingMappingList getLocalEncodingMappingList()
          Returns the value of the 'Local Encoding Mapping List' containment reference
 LoginConfig getLoginConfig()
           
 EList getMessageDestinations()
          Returns the value of the 'Message Destinations' containment reference list.
 EList getMimeMappings()
           
 java.lang.String getMimeType(java.lang.String extension)
          Returns the mime type for the specified extension
 SecurityRole getSecurityRoleNamed(java.lang.String roleName)
          Returns the SecurityRole with the specified name
 EList getSecurityRoles()
           
 ServletMapping getServletMapping(Servlet aServlet)
          Finds a servlet mapping for a specified servlet.
 EList getServletMappings()
           
 Servlet getServletNamed(java.lang.String name)
          Returns a Servlet with the specified name
 java.util.List getServletNames()
          Gets the names of the servlets defined for this web application.
 EList getServlets()
           
 SessionConfig getSessionConfig()
           
 EList getTagLibs()
           
 java.lang.String getVersion()
          Returns the value of the 'Version' attribute
 int getVersionID()
          This returns the module version id.
 boolean isDistributable()
           
 boolean isSetDistributable()
          Returns whether the value of the 'Distributable' attribute is set
 boolean isVersion2_2Descriptor()
          Deprecated. Use getVersionID() to determine module level
 boolean isVersion2_3Descriptor()
          Deprecated. Use getVersionID() to determine module level
 void renameSecurityRole(java.lang.String existingRoleName, java.lang.String newRoleName)
          Rename the security role if it exists; for each servlet, fix the role-link on any contained role refs
 void setDistributable(boolean value)
           
 void setFileList(WelcomeFileList value)
           
 void setJspConfig(JSPConfig value)
          Sets the value of the 'Jsp Config' containment reference
 void setLocalEncodingMappingList(LocalEncodingMappingList value)
          Sets the value of the 'Local Encoding Mapping List' containment reference
 void setLoginConfig(LoginConfig value)
           
 void setSessionConfig(SessionConfig value)
           
 void setVersion(java.lang.String value)
          Sets the value of the 'Version' attribute
 void unsetDistributable()
          Unsets the value of the 'Distributable' attribute
 
Methods inherited from interface org.eclipse.jst.j2ee.common.JNDIEnvRefsGroup
getEjbLocalRefs, getEjbRefs, getEnvironmentProperties, getMessageDestinationRefs, getResourceEnvRefs, getResourceRefs, getServiceRefs
 
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

containsSecurityRole

public boolean containsSecurityRole(java.lang.String name)
Returns true if there is a SecurityRole with the name passed

Parameters:
name - name of the SecurityRole
Returns:
boolean value

getErrorPageByCode

public ErrorPage getErrorPageByCode(java.lang.Integer code)
Returns an ErrorPage if it has the specified error code

Parameters:
code - the error code
Returns:
refernce to ErrorPage

getErrorPageByExceptionType

public ErrorPage getErrorPageByExceptionType(java.lang.String exceptionType)
Returns an ErrorPage given an exceptionType

Parameters:
exceptionType - the java Exception Type
Returns:
refernce to ErrorPage

getFilterMapping

public FilterMapping getFilterMapping(Filter aFilter)
Finds a filter mapping for a specified filter.

Parameters:
aFilter - The filter to find the mappings for.
Returns:
The filter mapping for the specified filter, or null if no mapping exists for the filter.

getFilterNamed

public Filter getFilterNamed(java.lang.String name)
Gets refernce to the instance of Filter which has the specified name

Parameters:
name - the name of the Filter to look for
Returns:
refernce to teh Filter

getFilterNames

public java.util.List getFilterNames()
Gets the names of the filters defined for this web application.

Returns:
A list of filter names (Strings).

getMimeType

public java.lang.String getMimeType(java.lang.String extension)
Returns the mime type for the specified extension

Parameters:
extension - to find the mime type for.
Returns:
String value

getSecurityRoleNamed

public SecurityRole getSecurityRoleNamed(java.lang.String roleName)
Returns the SecurityRole with the specified name

Parameters:
roleName - the name of the SecurityRole to be searched for
Returns:
reference to the model object SecurityRole

getServletMapping

public ServletMapping getServletMapping(Servlet aServlet)
Finds a servlet mapping for a specified servlet.

Parameters:
aServlet - The servlet to find the mappings for.
Returns:
The servlet mapping for the specified servlet, or null if no mapping exists for the servlet.

getServletNamed

public Servlet getServletNamed(java.lang.String name)
Returns a Servlet with the specified name

Parameters:
name - the name of the Servlet to search for
Returns:
reference to the model object Servlet

getServletNames

public java.util.List getServletNames()
Gets the names of the servlets defined for this web application.

Returns:
A list of servlet names (Strings).

isVersion2_2Descriptor

public boolean isVersion2_2Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Web App was populated from an Servlet2.2 compliant descriptor

Returns:
boolean

isVersion2_3Descriptor

public boolean isVersion2_3Descriptor()
Deprecated. Use getVersionID() to determine module level

Return boolean indicating if this Web App was populated from an Servlet2.3 compliant descriptor

Returns:
boolean

renameSecurityRole

public void renameSecurityRole(java.lang.String existingRoleName,
                               java.lang.String newRoleName)
Rename the security role if it exists; for each servlet, fix the role-link on any contained role refs

Parameters:
existingRoleName - curent security role name
newRoleName - new security role name

isDistributable

public boolean isDistributable()
Returns:
The value of the Distributable attribute The distributable element, by its presence in a web application deployment descriptor, indicates that this web application is programmed appropriately to be deployed into a distributed servlet container

setDistributable

public void setDistributable(boolean value)
Parameters:
value - The new value of the Distributable attribute

unsetDistributable

public void unsetDistributable()
Unsets the value of the 'Distributable' attribute.

See Also:
isSetDistributable(), isDistributable(), setDistributable(boolean)

isSetDistributable

public boolean isSetDistributable()
Returns whether the value of the 'Distributable' attribute is set.

Returns:
whether the value of the 'Distributable' attribute is set.
See Also:
unsetDistributable(), isDistributable(), setDistributable(boolean)

getVersion

public java.lang.String getVersion()
Returns the value of the 'Version' attribute.

If the meaning of the 'Version' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Version' attribute.
See Also:
setVersion(String), WebapplicationPackage.getWebApp_Version()

getVersionID

public int getVersionID()
                 throws java.lang.IllegalStateException
This returns the module version id. Compare with J2EEVersionConstants to determine module level

Returns:
the module version id represented in the int e.g. 22, 23, 24
Throws:
java.lang.IllegalStateException - the exception is thrown if a problem is encountered in finding the module version. *

getJ2EEVersionID

public int getJ2EEVersionID()
                     throws java.lang.IllegalStateException
This returns the j2ee version id. Compare with J2EEVersionConstants to determine j2ee level

Returns:
the j2ee version represented in the int
Throws:
java.lang.IllegalStateException - the exception is thrown if a problem is encountered in finding the j2ee version.

setVersion

public void setVersion(java.lang.String value)
Sets the value of the 'Version' attribute.

Parameters:
value - the new value of the 'Version' attribute.
See Also:
getVersion()

getContexts

public EList getContexts()
Returns:
The list of Contexts references

getErrorPages

public EList getErrorPages()
Returns:
The list of ErrorPages references

getFileList

public WelcomeFileList getFileList()
Returns:
The FileList reference

getEnvEntries

public EList getEnvEntries()
Deprecated. : Use getEnvironmentProperties()

Returns:
reference to EList

setFileList

public void setFileList(WelcomeFileList value)
Parameters:
value - The new value of the FileList reference

getTagLibs

public EList getTagLibs()
Returns:
The list of TagLibs references

getConstraints

public EList getConstraints()
Returns:
The list of Constraints references

getLoginConfig

public LoginConfig getLoginConfig()
Returns:
The LoginConfig reference

setLoginConfig

public void setLoginConfig(LoginConfig value)
Parameters:
value - The new value of the LoginConfig reference

getMimeMappings

public EList getMimeMappings()
Returns:
The list of MimeMappings references

getSessionConfig

public SessionConfig getSessionConfig()
Returns:
The SessionConfig reference

setSessionConfig

public void setSessionConfig(SessionConfig value)
Parameters:
value - The new value of the SessionConfig reference

getServletMappings

public EList getServletMappings()
Returns:
The list of ServletMappings references

getServlets

public EList getServlets()
Returns:
The list of Servlets references

getSecurityRoles

public EList getSecurityRoles()
Returns:
The list of SecurityRoles references

getFilters

public EList getFilters()
Returns:
The list of Filters references

getFilterMappings

public EList getFilterMappings()
Returns:
The list of FilterMappings references Filter mappings defined for the web app

getListeners

public EList getListeners()
Returns:
The list of Listeners references The listeners collection contains deployment properties for a web application listener beans in the web app.

getContextParams

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

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

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

getJspConfig

public JSPConfig getJspConfig()
Returns the value of the 'Jsp Config' containment reference.

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

Returns:
the value of the 'Jsp Config' containment reference.
See Also:
setJspConfig(JSPConfig), WebapplicationPackage.getWebApp_JspConfig()

setJspConfig

public void setJspConfig(JSPConfig value)
Sets the value of the 'Jsp Config' containment reference.

Parameters:
value - the new value of the 'Jsp Config' containment reference.
See Also:
getJspConfig()

getMessageDestinations

public EList getMessageDestinations()
Returns the value of the 'Message Destinations' containment reference list. The list contents are of type MessageDestination.

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

Returns:
the value of the 'Message Destinations' containment reference list.
See Also:
WebapplicationPackage.getWebApp_MessageDestinations()

getLocalEncodingMappingList

public LocalEncodingMappingList getLocalEncodingMappingList()
Returns the value of the 'Local Encoding Mapping List' containment reference.

If the meaning of the 'Local Encoding Mapping List' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Local Encoding Mapping List' containment reference.
See Also:
setLocalEncodingMappingList(LocalEncodingMappingList), WebapplicationPackage.getWebApp_LocalEncodingMappingList()

setLocalEncodingMappingList

public void setLocalEncodingMappingList(LocalEncodingMappingList value)
Sets the value of the 'Local Encoding Mapping List' containment reference.

Parameters:
value - the new value of the 'Local Encoding Mapping List' containment reference.
See Also:
getLocalEncodingMappingList()