Interface WebModuleMetaData
- 
- All Superinterfaces:
- com.ibm.ws.runtime.metadata.MetaData,- com.ibm.ws.runtime.metadata.ModuleMetaData
 
 public interface WebModuleMetaData extends com.ibm.ws.runtime.metadata.ModuleMetaDataThe metadata associated a WebModule runtime object.
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.ObjectgetAnnotatedSecurityMetaData()WebCollaboratorComponentMetaDatagetCollaboratorComponentMetaData()WebAppConfiggetConfiguration()Returns the WebAppConfig associated with the webModule that this metaData object is attached to.BaseJspComponentMetaDatagetJspComponentMetadata()Gets the Module level JSP specific metaData that is associated with the module to which this metaData object is attached to.java.lang.ObjectgetSecurityMetaData()Returns the securityMetaData object attached to the module associated with this metaData object NOTE: This method must only be invoked by security providers who had earlier pushed the securityMetaData objects into this metaData during metadata creation.java.lang.StringgetSessionCookieNameInUse()Call to retrieve the cookieName in use for this web module.booleanisServlet23OrHigher()Returns if the webmodule associated with this metaData object is atleast compliant with the Servlet 2.3 specificationvoidsetAnnotatedSecurityMetaData(java.lang.Object metaData)voidsetCollaboratorComponentMetaData(WebCollaboratorComponentMetaData wcmd)voidsetJspComponentMetadata(BaseJspComponentMetaData metaData)Call to push the JSP specific metaData into this metaData object at metaData creation time.voidsetSecurityMetaData(java.lang.Object metaData)Call to push the securityMetaData into this metaData object at metaData creation time.voidsetSessionCookieNameInUse(java.lang.String cookieName)Call to set the cookieName in use for this web module.
 
- 
- 
- 
Method Detail- 
isServlet23OrHigherboolean isServlet23OrHigher() Returns if the webmodule associated with this metaData object is atleast compliant with the Servlet 2.3 specification- Returns:
 
 - 
getConfigurationWebAppConfig getConfiguration() Returns the WebAppConfig associated with the webModule that this metaData object is attached to.- Returns:
 
 - 
getJspComponentMetadataBaseJspComponentMetaData getJspComponentMetadata() Gets the Module level JSP specific metaData that is associated with the module to which this metaData object is attached to. NOTE: This method must only be invoked by JSP Container implementations who had earlier pushed the securityMetaData objects into this metaData during metadata creation.- Returns:
 
 - 
setJspComponentMetadatavoid setJspComponentMetadata(BaseJspComponentMetaData metaData) Call to push the JSP specific metaData into this metaData object at metaData creation time. This is typically done by JSP container implementations, only to retrieve it again at the time when the component is invoked at runtime.- Parameters:
- metaData-
 
 - 
getSecurityMetaDatajava.lang.Object getSecurityMetaData() Returns the securityMetaData object attached to the module associated with this metaData object NOTE: This method must only be invoked by security providers who had earlier pushed the securityMetaData objects into this metaData during metadata creation.- Returns:
 
 - 
getAnnotatedSecurityMetaDatajava.lang.Object getAnnotatedSecurityMetaData() 
 - 
setSecurityMetaDatavoid setSecurityMetaData(java.lang.Object metaData) Call to push the securityMetaData into this metaData object at metaData creation time. This is typically done by security providers, who push security constraint representations for the component associated with this metaData object, only to retrieve it again at the time when the component is invoked at runtime.- Parameters:
- metaData-
 
 - 
setAnnotatedSecurityMetaDatavoid setAnnotatedSecurityMetaData(java.lang.Object metaData) 
 - 
setSessionCookieNameInUsevoid setSessionCookieNameInUse(java.lang.String cookieName) Call to set the cookieName in use for this web module. This can be retrieved by other components which need to use this name for routing.
 - 
getSessionCookieNameInUsejava.lang.String getSessionCookieNameInUse() Call to retrieve the cookieName in use for this web module. This can be called by other components which need to use this name for routing.
 - 
setCollaboratorComponentMetaDatavoid setCollaboratorComponentMetaData(WebCollaboratorComponentMetaData wcmd) 
 - 
getCollaboratorComponentMetaDataWebCollaboratorComponentMetaData getCollaboratorComponentMetaData() 
 
- 
 
-