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

      Fields 
      Modifier and Type Field Description
      static int JSP  
      static int SERVLET  
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getCallbacksId()  
      java.lang.String getImplementationClass()
      Returns the compiled classname of the associated component
      java.util.ArrayList getPageListMetaData()
      Returns the list of PageList metaDatas associated with the component to which this metaData object is attached.
      java.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.
      IServletConfig getServletConfig()
      Returns the IServletConfig interface associated with the component to wehich this metaData object is attached.
      java.lang.String getWebComponentDescription()
      Returns the description of the component associated with this metaData object
      java.util.Map getWebComponentInitParameters()
      Returns the initialization parameters that have been configured for the component associated with tihs metaData Object.
      int getWebComponentType()
      Returns the type of component associated with this metadata object.
      java.lang.String getWebComponentVersion()
      Returns the version of the servlet specification this servlet is compliant with.
      void handleCallbacks()  
      void handleCallbacks​(int callbacksIdInt)  
      boolean isTypeJSP()
      Returns whether or not the component associated with this metaData object is a JSP.
      int setCallbacksID()  
      void setSecurityMetaData​(java.lang.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
    • Method Detail

      • getWebComponentType

        int getWebComponentType()
        Returns the type of component associated with this metadata object. The current types are SERVLET and JSP
        Returns:
      • getWebComponentVersion

        java.lang.String getWebComponentVersion()
        Returns the version of the servlet specification this servlet is compliant with.
        Returns:
      • getImplementationClass

        java.lang.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

        java.lang.String getWebComponentDescription()
        Returns the description of the component associated with this metaData object
        Returns:
      • getWebComponentInitParameters

        java.util.Map getWebComponentInitParameters()
        Returns the initialization parameters that have been configured for the component associated with tihs metaData Object.
        Returns:
      • getPageListMetaData

        java.util.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

        java.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:
      • 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 -
      • handleCallbacks

        void handleCallbacks()
      • setCallbacksID

        int setCallbacksID()
      • getCallbacksId

        int getCallbacksId()
      • handleCallbacks

        void handleCallbacks​(int callbacksIdInt)