Interface WebComponentMetaData
- All Superinterfaces:
com.ibm.ws.runtime.metadata.ComponentMetaData
,com.ibm.ws.runtime.metadata.MetaData
public interface WebComponentMetaData
extends com.ibm.ws.runtime.metadata.ComponentMetaData
The metadata for a component in a Web Module (ie., a Servlet, or a JSP or any other
entity compiled as a Servlet), which gets shared accross components. Components
can push their optimized config data associated with the servlet onto this
metaData and they can retrieve them upon invocation wither from the invocation
call or from the ThreadContext
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
Returns the compiled classname of the associated componentReturns the list of PageList metaDatas associated with the component to which this metaData object is attached.Returns the securityMetaData object attached to the component 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 the IServletConfig interface associated with the component to wehich this metaData object is attached.Returns the description of the component associated with this metaData objectReturns the initialization parameters that have been configured for the component associated with tihs metaData Object.int
Returns the type of component associated with this metadata object.Returns the version of the servlet specification this servlet is compliant with.void
void
handleCallbacks
(int callbacksIdInt) boolean
Returns whether or not the component associated with this metaData object is a JSP.int
void
setSecurityMetaData
(Object metaData) Call to push the securityMetaData into this metaData object at metaData creation time.Methods inherited from interface com.ibm.ws.runtime.metadata.ComponentMetaData
getJ2EEName, getModuleMetaData
Methods inherited from interface com.ibm.ws.runtime.metadata.MetaData
getMetaData, getName, release, setMetaData
-
Field Details
-
SERVLET
static final int SERVLET- See Also:
-
JSP
static final int JSP- See Also:
-
-
Method Details
-
getWebComponentType
int getWebComponentType()Returns the type of component associated with this metadata object. The current types are SERVLET and JSP- Returns:
-
getWebComponentVersion
String getWebComponentVersion()Returns the version of the servlet specification this servlet is compliant with.- Returns:
-
getImplementationClass
String getImplementationClass()Returns the compiled classname of the associated component- Returns:
-
isTypeJSP
boolean isTypeJSP()Returns whether or not the component associated with this metaData object is a JSP.- Returns:
-
getWebComponentDescription
String getWebComponentDescription()Returns the description of the component associated with this metaData object- Returns:
-
getWebComponentInitParameters
Map getWebComponentInitParameters()Returns the initialization parameters that have been configured for the component associated with tihs metaData Object.- Returns:
-
getPageListMetaData
ArrayList getPageListMetaData()Returns the list of PageList metaDatas associated with the component to which this metaData object is attached.- Returns:
-
getServletConfig
IServletConfig getServletConfig()Returns the IServletConfig interface associated with the component to wehich this metaData object is attached.- Returns:
-
getSecurityMetaData
Object getSecurityMetaData()Returns the securityMetaData object attached to the component 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:
-
setSecurityMetaData
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
-
-
handleCallbacks
void handleCallbacks() -
setCallbacksID
int setCallbacksID() -
getCallbacksId
int getCallbacksId() -
handleCallbacks
void handleCallbacks(int callbacksIdInt)
-