com.ibm.wsspi.webcontainer.webapp
Interface WebAppConfig


public interface WebAppConfig


Method Summary
 void addClassesToScan(java.util.List<java.lang.Class<?>> list)
           
 void addListener(java.lang.String listenerClass)
          Adds a listener to be processed
 void addServletInfo(java.lang.String name, IServletConfig info)
           
 void addServletMappedFilterInfo(IFilterMapping fmInfo)
           
 void addServletMapping(java.lang.String servletName, java.lang.String urlPattern)
          Adds a new urlPattern for the specified servlet to the list of mappings
 void addUriMappedFilterInfo(IFilterMapping fmInfo)
           
 java.lang.String getApplicationName()
          Returns the name of the application this config is associated with
 int getAppStartupWeight()
          Returns the startup weight specified for the enterprise application
 java.lang.String getArdDispatchType()
           
 java.util.List<java.lang.Class<?>> getClassesToScan()
           
 java.lang.String getContextRoot()
          Returns the context root for the application which this web module is a part of
 java.util.Iterator getFilterInfos()
          Returns an iterator containing all the FilterConfig instances which represent all the targets that are present and loaded (not necessarily initialized) in this web module
 java.util.List<IFilterMapping> getFilterMappings()
           
 java.util.Map getJspAttributes()
          Returns the JSP Attributes for the web module that this config is associated with
 int getLastIndexBeforeDeclaredFilters()
           
 java.util.List<java.lang.String> getLibBinPathList()
           
 java.util.List getListeners()
          Returns the listeners.
 com.ibm.wsspi.webcontainer.metadata.WebModuleMetaData getMetaData()
          Returns the Module metadata associated with this config
 java.lang.String getModuleName()
          Returns the name of the module that this config is associated with
 int getModuleStartupWeight()
          Returns the startup weight specified for the web module
 IServletConfig getServletInfo(java.lang.String servletName)
           
 java.util.Iterator<IServletConfig> getServletInfos()
          Returns an iterator containing all the ServletConfig instances which represent all the targets that are present and loaded (not necessarily initialized) in this web module
 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getServletMappings()
          Returns a map whose keys are the servlet names and whose values are each servlet's servlet mappings list
 java.util.Iterator getServletNames()
          Returns an iterator containing all the ServletNames
 java.util.List getTagLibs()
          Returns a list of all the TagLib definitions for this web module
 java.util.List getVirtualHostList()
          Returns the list of the virtual host mappings the web module has been associated with.
 java.lang.String getVirtualHostName()
          Returns the name of the virtual host that the web module has been associated with.
 boolean isArdEnabled()
           
 boolean isAutoResponseEncoding()
          Determines whether or not this web module has enabled IBM custom extension autoResponseEncoding.
 boolean isDistributable()
          Returns whether the app is distributable.
 boolean isErrorPagePresent()
           
 boolean isJCDIEnabled()
           
 boolean isMetadataComplete()
           
 boolean isServlet2_4()
          Determines whether or not this web module is compliant with the Servlet 2.4 specification
 boolean isServlet2_4OrHigher()
          Determines whether or not this web module is compliant with the Servlet 2.4 specification or later
 boolean isServlet2_5()
          Determines whether or not this web module is compliant with the Servlet 2.5 specification
 boolean isSystemApp()
           
 void setArdDispatchType(java.lang.String ardDispatchType)
           
 void setJCDIEnabled(boolean b)
           
 void setLastIndexBeforeDeclaredFilters(int lastIndexBeforeDeclaredFilters)
           
 void setMetadataComplete(boolean b)
           
 

Method Detail

getJspAttributes

java.util.Map getJspAttributes()
Returns the JSP Attributes for the web module that this config is associated with

Returns:

isServlet2_4

boolean isServlet2_4()
Determines whether or not this web module is compliant with the Servlet 2.4 specification

Returns:

isServlet2_5

boolean isServlet2_5()
Determines whether or not this web module is compliant with the Servlet 2.5 specification

Returns:

isServlet2_4OrHigher

boolean isServlet2_4OrHigher()
Determines whether or not this web module is compliant with the Servlet 2.4 specification or later

Returns:

getModuleName

java.lang.String getModuleName()
Returns the name of the module that this config is associated with

Returns:

getApplicationName

java.lang.String getApplicationName()
Returns the name of the application this config is associated with

Returns:
String

getServletInfos

java.util.Iterator<IServletConfig> getServletInfos()
Returns an iterator containing all the ServletConfig instances which represent all the targets that are present and loaded (not necessarily initialized) in this web module

Returns:

getServletMappings

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getServletMappings()
Returns a map whose keys are the servlet names and whose values are each servlet's servlet mappings list

Returns:

getServletNames

java.util.Iterator getServletNames()
Returns an iterator containing all the ServletNames

Returns:

getTagLibs

java.util.List getTagLibs()
Returns a list of all the TagLib definitions for this web module

Returns:

getContextRoot

java.lang.String getContextRoot()
Returns the context root for the application which this web module is a part of

Returns:

getMetaData

com.ibm.wsspi.webcontainer.metadata.WebModuleMetaData getMetaData()
Returns the Module metadata associated with this config

Returns:

isAutoResponseEncoding

boolean isAutoResponseEncoding()
Determines whether or not this web module has enabled IBM custom extension autoResponseEncoding.

Returns:

getFilterInfos

java.util.Iterator getFilterInfos()
Returns an iterator containing all the FilterConfig instances which represent all the targets that are present and loaded (not necessarily initialized) in this web module

Returns:

getLastIndexBeforeDeclaredFilters

int getLastIndexBeforeDeclaredFilters()

setLastIndexBeforeDeclaredFilters

void setLastIndexBeforeDeclaredFilters(int lastIndexBeforeDeclaredFilters)

getFilterMappings

java.util.List<IFilterMapping> getFilterMappings()

getVirtualHostList

java.util.List getVirtualHostList()
Returns the list of the virtual host mappings the web module has been associated with.

Returns:

getVirtualHostName

java.lang.String getVirtualHostName()
Returns the name of the virtual host that the web module has been associated with.

Returns:

getAppStartupWeight

int getAppStartupWeight()
Returns the startup weight specified for the enterprise application

Returns:
int

getModuleStartupWeight

int getModuleStartupWeight()
Returns the startup weight specified for the web module

Returns:
int

isDistributable

boolean isDistributable()
Returns whether the app is distributable. Can be used to indicate the need for replication of session data.

Returns:
boolean

isSystemApp

boolean isSystemApp()

getServletInfo

IServletConfig getServletInfo(java.lang.String servletName)

addServletInfo

void addServletInfo(java.lang.String name,
                    IServletConfig info)

addServletMapping

void addServletMapping(java.lang.String servletName,
                       java.lang.String urlPattern)
Adds a new urlPattern for the specified servlet to the list of mappings


isArdEnabled

boolean isArdEnabled()

setArdDispatchType

void setArdDispatchType(java.lang.String ardDispatchType)

getArdDispatchType

java.lang.String getArdDispatchType()

setMetadataComplete

void setMetadataComplete(boolean b)

isMetadataComplete

boolean isMetadataComplete()

addClassesToScan

void addClassesToScan(java.util.List<java.lang.Class<?>> list)

getClassesToScan

java.util.List<java.lang.Class<?>> getClassesToScan()

addUriMappedFilterInfo

void addUriMappedFilterInfo(IFilterMapping fmInfo)

addServletMappedFilterInfo

void addServletMappedFilterInfo(IFilterMapping fmInfo)

getListeners

java.util.List getListeners()
Returns the listeners.

Returns:
List

addListener

void addListener(java.lang.String listenerClass)
Adds a listener to be processed

Parameters:
listenerClass - the name of the listener class to add

getLibBinPathList

java.util.List<java.lang.String> getLibBinPathList()

setJCDIEnabled

void setJCDIEnabled(boolean b)

isJCDIEnabled

boolean isJCDIEnabled()

isErrorPagePresent

boolean isErrorPagePresent()