Package com.ibm.wsspi.webcontainer.servlet

Interface IServletConfig

All Superinterfaces:
jakarta.servlet.Registration, jakarta.servlet.Registration.Dynamic, jakarta.servlet.ServletConfig, jakarta.servlet.ServletRegistration, jakarta.servlet.ServletRegistration.Dynamic
public interface IServletConfig extends jakarta.servlet.ServletConfig, jakarta.servlet.ServletRegistration.Dynamic

  • Method Details

    • setClassName

      void setClassName(String string)
      Set the classname of the servlet that is represented by this config object
      Parameters:
      string -

    • getFileName

      String getFileName()
      Returns the file name that may be associated with this config. The value will be non-null only in the case where the target represented by this config is a JSP.
      Returns:

    • isLoadOnStartup

      boolean isLoadOnStartup()
      Returns whether or not the servlet represented by this config should be loaded at startup. For servlets added and configured dynamically (as is the case with JSPs), it means that the target will be initialized through the init() method at the time of creation, as opposed to when the first request for thie resource arrives.
      Returns:

    • setFileName

      void setFileName(String jspUri)
      Sets the fileName associated with this config
      Parameters:
      jspUri -

    • setInitParams

      void setInitParams(Map map)
      Sets the Map of initialization parameters for the servlet associated with this config instance.
      Parameters:
      map -

    • setIsJsp

      void setIsJsp(boolean b)
      Sets whether or not this config represents a JSP file.
      Parameters:
      b -

    • setServletContext

      void setServletContext(jakarta.servlet.ServletContext context)
      Associates the given context with this Servlet's config.
      Parameters:
      context -

    • setServletName

      void setServletName(String jspRegisteredName)
      Set the servletName for this config
      Parameters:
      jspRegisteredName -

    • setDisplayName

      void setDisplayName(String jspRegisteredName)
      Set the display name for this config
      Parameters:
      jspRegisteredName -

    • getClassName

      String getClassName()
      Set the classname for the servlet represented by this config
      Specified by:
      getClassName in interface jakarta.servlet.Registration
      Returns:

    • setStartUpWeight

      void setStartUpWeight(Integer integer)
      Set the startup weight for the servlet represented by this config. Setting a value >= 0 tells the container not to wait until the first request for this servlet to initialize it.
      Parameters:
      integer -

    • addAttribute

      void addAttribute(Object key, Object value)
      Add an attribute for this config
      Parameters:
      key -
      value -

    • setAttributes

      void setAttributes(Map map)
      Set the current attribute map to the passed in parameter
      Parameters:
      map -

    • removeAttribute

      Object removeAttribute(Object key)
      Remove an attribute for this config
      Parameters:
      key -
      Returns:

    • getMetaData

      WebComponentMetaData getMetaData()
      Returns the component metadata associated with this configuration
      Returns:

    • setMetaData

      void setMetaData(WebComponentMetaData metaData)
      Sets the component metadata associated with this configuration

    • isCachingEnabled

      boolean isCachingEnabled()
      Checks if caching is enabled for the servlet (requires dynacache to be enabled to have desired effect).
      Returns:

    • setIsCachingEnabled

      void setIsCachingEnabled(boolean isEnabled)
      Set whether caching is enabled for a servlet (requires dynacache to have desired effect).

    • setStatisticsEnabled

      void setStatisticsEnabled(boolean value)
      Set whether performance monitoring statistics are enabled.
      Parameters:
      value -

    • isStatisticsEnabled

      boolean isStatisticsEnabled()
      Check if performance monitoring statistics are enabled.
      Returns:

    • isJsp

      boolean isJsp()

    • getStartUpWeight

      int getStartUpWeight()

    • setDescription

      void setDescription(String description)

    • setInternal

      void setInternal(boolean isInternal)
      Set whether resource should be considered internal. * @return

    • isInternal

      boolean isInternal()
      Checks if resource should be considered internal.
      Returns:

    • isSingleThreadModelServlet

      boolean isSingleThreadModelServlet()

    • setSingleThreadModelServlet

      void setSingleThreadModelServlet(boolean isSTM)

    • setServletWrapper

      void setServletWrapper(IServletWrapper wrapper)

    • getServletWrapper

      IServletWrapper getServletWrapper()

    • setServletClass

      void setServletClass(Class<? extends jakarta.servlet.Servlet> servletClass)

    • setServlet

      void setServlet(jakarta.servlet.Servlet servlet)

    • getServletClass

      Class<? extends jakarta.servlet.Servlet> getServletClass()

    • getServlet

      jakarta.servlet.Servlet getServlet()

    • setMappings

      void setMappings(List<String> mappings)

    • getMappings

      List<String> getMappings()
      Specified by:
      getMappings in interface jakarta.servlet.ServletRegistration

    • isAddedToLoadOnStartup

      boolean isAddedToLoadOnStartup()

    • isAsyncSupported

      boolean isAsyncSupported()

    • setAddedToLoadOnStartup

      void setAddedToLoadOnStartup(boolean addedToLoadOnStartup)

    • isWeightChanged

      boolean isWeightChanged()

    • getMultipartConfig

      jakarta.servlet.MultipartConfigElement getMultipartConfig()

    • getMultipartBaseLocation

      File getMultipartBaseLocation()

    • setMultipartBaseLocation

      void setMultipartBaseLocation(File location)

    • addMapping

      Set<String> addMapping(IServletConfig.CheckContextInitialized checkContextInitialized, String... mappingURI)

    • getServletSecurity

      jakarta.servlet.ServletSecurityElement getServletSecurity()

    • isClassDefined

      boolean isClassDefined()

    • isEnabled

      boolean isEnabled()