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.ComponentMetaDataThe 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
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description intgetCallbacksId()java.lang.StringgetImplementationClass()Returns the compiled classname of the associated componentjava.util.ArrayListgetPageListMetaData()Returns the list of PageList metaDatas associated with the component to which this metaData object is attached.java.lang.ObjectgetSecurityMetaData()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.IServletConfiggetServletConfig()Returns the IServletConfig interface associated with the component to wehich this metaData object is attached.java.lang.StringgetWebComponentDescription()Returns the description of the component associated with this metaData objectjava.util.MapgetWebComponentInitParameters()Returns the initialization parameters that have been configured for the component associated with tihs metaData Object.intgetWebComponentType()Returns the type of component associated with this metadata object.java.lang.StringgetWebComponentVersion()Returns the version of the servlet specification this servlet is compliant with.voidhandleCallbacks()voidhandleCallbacks(int callbacksIdInt)booleanisTypeJSP()Returns whether or not the component associated with this metaData object is a JSP.intsetCallbacksID()voidsetSecurityMetaData(java.lang.Object metaData)Call to push the securityMetaData into this metaData object at metaData creation time.
 
- 
- 
- 
Field Detail- 
SERVLETstatic final int SERVLET - See Also:
- Constant Field Values
 
 - 
JSPstatic final int JSP - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getWebComponentTypeint getWebComponentType() Returns the type of component associated with this metadata object. The current types are SERVLET and JSP- Returns:
 
 - 
getWebComponentVersionjava.lang.String getWebComponentVersion() Returns the version of the servlet specification this servlet is compliant with.- Returns:
 
 - 
getImplementationClassjava.lang.String getImplementationClass() Returns the compiled classname of the associated component- Returns:
 
 - 
isTypeJSPboolean isTypeJSP() Returns whether or not the component associated with this metaData object is a JSP.- Returns:
 
 - 
getWebComponentDescriptionjava.lang.String getWebComponentDescription() Returns the description of the component associated with this metaData object- Returns:
 
 - 
getWebComponentInitParametersjava.util.Map getWebComponentInitParameters() Returns the initialization parameters that have been configured for the component associated with tihs metaData Object.- Returns:
 
 - 
getPageListMetaDatajava.util.ArrayList getPageListMetaData() Returns the list of PageList metaDatas associated with the component to which this metaData object is attached.- Returns:
 
 - 
getServletConfigIServletConfig getServletConfig() Returns the IServletConfig interface associated with the component to wehich this metaData object is attached.- Returns:
 
 - 
getSecurityMetaDatajava.lang.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:
 
 - 
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-
 
 - 
handleCallbacksvoid handleCallbacks() 
 - 
setCallbacksIDint setCallbacksID() 
 - 
getCallbacksIdint getCallbacksId() 
 - 
handleCallbacksvoid handleCallbacks(int callbacksIdInt) 
 
- 
 
-