org.eclipse.jst.j2ee.webapplication
Interface WebApp

All Superinterfaces:
CompatibilityDescriptionGroup, DescriptionGroup, org.eclipse.emf.ecore.EObject, J2EEEObject, JNDIEnvRefsGroup, org.eclipse.emf.common.notify.Notifier

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
 org.eclipse.emf.common.util.EList getConstraints()
           
 org.eclipse.emf.common.util.EList getContextParams()
          Returns the value of the 'Context Params' containment reference list.
 org.eclipse.emf.common.util.EList getContexts()
           
 org.eclipse.emf.common.util.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
 org.eclipse.emf.common.util.EList getErrorPages()
           
 WelcomeFileList getFileList()
           
 FilterMapping getFilterMapping(Filter aFilter)
          Finds a filter mapping for a specified filter.
 org.eclipse.emf.common.util.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.
 org.eclipse.emf.common.util.EList getFilters()
           
 int getJ2EEVersionID()
          This returns the j2ee version id.
 JSPConfig getJspConfig()
          Returns the value of the 'Jsp Config' containment reference
 org.eclipse.emf.common.util.EList getListeners()
           
 LocalEncodingMappingList getLocalEncodingMappingList()
          Returns the value of the 'Local Encoding Mapping List' containment reference
 LoginConfig getLoginConfig()
           
 org.eclipse.emf.common.util.EList getMessageDestinations()
          Returns the value of the 'Message Destinations' containment reference list.
 org.eclipse.emf.common.util.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
 org.eclipse.emf.common.util.EList getSecurityRoles()
           
 ServletMapping getServletMapping(Servlet aServlet)
          Finds a servlet mapping for a specified servlet.
 org.eclipse.emf.common.util.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.
 org.eclipse.emf.common.util.EList getServlets()
           
 SessionConfig getSessionConfig()
           
 org.eclipse.emf.common.util.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
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

containsSecurityRole

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

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

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

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

getFilterMapping

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

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

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

Returns:
A list of filter names (Strings).

getMimeType

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

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

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

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

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

Returns:
A list of servlet names (Strings).

isVersion2_2Descriptor

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

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

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

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

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

unsetDistributable

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

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

isSetDistributable

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

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

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

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

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

org.eclipse.emf.common.util.EList getContexts()
Returns:
The list of Contexts references

getErrorPages

org.eclipse.emf.common.util.EList getErrorPages()
Returns:
The list of ErrorPages references

getFileList

WelcomeFileList getFileList()
Returns:
The FileList reference

getEnvEntries

org.eclipse.emf.common.util.EList getEnvEntries()
Deprecated. : Use getEnvironmentProperties()

Returns:
reference to EList

setFileList

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

getTagLibs

org.eclipse.emf.common.util.EList getTagLibs()
Returns:
The list of TagLibs references

getConstraints

org.eclipse.emf.common.util.EList getConstraints()
Returns:
The list of Constraints references

getLoginConfig

LoginConfig getLoginConfig()
Returns:
The LoginConfig reference

setLoginConfig

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

getMimeMappings

org.eclipse.emf.common.util.EList getMimeMappings()
Returns:
The list of MimeMappings references

getSessionConfig

SessionConfig getSessionConfig()
Returns:
The SessionConfig reference

setSessionConfig

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

getServletMappings

org.eclipse.emf.common.util.EList getServletMappings()
Returns:
The list of ServletMappings references

getServlets

org.eclipse.emf.common.util.EList getServlets()
Returns:
The list of Servlets references

getSecurityRoles

org.eclipse.emf.common.util.EList getSecurityRoles()
Returns:
The list of SecurityRoles references

getFilters

org.eclipse.emf.common.util.EList getFilters()
Returns:
The list of Filters references

getFilterMappings

org.eclipse.emf.common.util.EList getFilterMappings()
Returns:
The list of FilterMappings references Filter mappings defined for the web app

getListeners

org.eclipse.emf.common.util.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

org.eclipse.emf.common.util.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

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

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

org.eclipse.emf.common.util.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

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

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