com.ibm.wsspi.webcontainer.metadata

Interface WebComponentMetaData


  1. public interface WebComponentMetaData
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

Modifier and Type Field and Description
  1. static
  2. int
JSP
  1. static
  2. int
SERVLET

Method Summary

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

Field Detail

SERVLET

  1. static final int SERVLET
See Also:

JSP

  1. static final int JSP
See Also:

Method Detail

getWebComponentType

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

getWebComponentVersion

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

getImplementationClass

  1. java.lang.String getImplementationClass( )
Returns the compiled classname of the associated component
Returns:

isTypeJSP

  1. boolean isTypeJSP()
Returns whether or not the component associated with this metaData object is a JSP.
Returns:

getWebComponentDescription

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

getWebComponentInitParameters

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

getPageListMetaData

  1. java.util.ArrayList getPageListMetaData( )
Returns the list of PageList metaDatas associated with the component to which this metaData object is attached.
Returns:

getServletConfig

  1. IServletConfig getServletConfig( )
Returns the IServletConfig interface associated with the component to wehich this metaData object is attached.
Returns:

getSecurityMetaData

  1. 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

  1. 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

  1. void handleCallbacks()

setCallbacksID

  1. int setCallbacksID()

getCallbacksId

  1. int getCallbacksId()

handleCallbacks

  1. void handleCallbacks(int callbacksIdInt)