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.ModuleMetaData
The metadata associated a WebModule runtime object.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Object
getAnnotatedSecurityMetaData()
WebCollaboratorComponentMetaData
getCollaboratorComponentMetaData()
WebAppConfig
getConfiguration()
Returns the WebAppConfig associated with the webModule that this metaData object is attached to.BaseJspComponentMetaData
getJspComponentMetadata()
Gets the Module level JSP specific metaData that is associated with the module to which this metaData object is attached to.java.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.java.lang.String
getSessionCookieNameInUse()
Call to retrieve the cookieName in use for this web module.boolean
isServlet23OrHigher()
Returns if the webmodule associated with this metaData object is atleast compliant with the Servlet 2.3 specificationvoid
setAnnotatedSecurityMetaData(java.lang.Object metaData)
void
setCollaboratorComponentMetaData(WebCollaboratorComponentMetaData wcmd)
void
setJspComponentMetadata(BaseJspComponentMetaData metaData)
Call to push the JSP specific metaData into this metaData object at metaData creation time.void
setSecurityMetaData(java.lang.Object metaData)
Call to push the securityMetaData into this metaData object at metaData creation time.void
setSessionCookieNameInUse(java.lang.String cookieName)
Call to set the cookieName in use for this web module.
-
-
-
Method Detail
-
isServlet23OrHigher
boolean isServlet23OrHigher()
Returns if the webmodule associated with this metaData object is atleast compliant with the Servlet 2.3 specification- Returns:
-
getConfiguration
WebAppConfig getConfiguration()
Returns the WebAppConfig associated with the webModule that this metaData object is attached to.- Returns:
-
getJspComponentMetadata
BaseJspComponentMetaData 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:
-
setJspComponentMetadata
void 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
-
-
getSecurityMetaData
java.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:
-
getAnnotatedSecurityMetaData
java.lang.Object getAnnotatedSecurityMetaData()
-
setSecurityMetaData
void 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
-
-
setAnnotatedSecurityMetaData
void setAnnotatedSecurityMetaData(java.lang.Object metaData)
-
setSessionCookieNameInUse
void 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.
-
getSessionCookieNameInUse
java.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.
-
setCollaboratorComponentMetaData
void setCollaboratorComponentMetaData(WebCollaboratorComponentMetaData wcmd)
-
getCollaboratorComponentMetaData
WebCollaboratorComponentMetaData getCollaboratorComponentMetaData()
-
-