com.ibm.wsspi.webcontainer.servlet

Interface IServletConfig


  1. public interface IServletConfig

Nested Class Summary

Modifier and Type Interface and Description
  1. static class
IServletConfig.CheckContextInitialized

Method Summary

Modifier and Type Method and Description
  1. void
addAttribute(java.lang.Object key,java.lang.Object value)
Add an attribute for this config
  1. java.util.Set<java.lang.String>
addMapping(IServletConfig.CheckContextInitialized checkContextInitialized,java.lang.String... mappingURI)
  1. java.lang.String
getClassName()
Set the classname for the servlet represented by this config
  1. java.lang.String
getFileName()
Returns the file name that may be associated with this config.
  1. java.util.List<java.lang.String>
getMappings()
  1. WebComponentMetaData
getMetaData()
Returns the component metadata associated with this configuration
  1. java.io.File
getMultipartBaseLocation()
  1. MultipartConfigElement
getMultipartConfig()
  1. Servlet
getServlet()
  1. java.lang.Class<? extends Servlet>
getServletClass()
  1. ServletSecurityElement
getServletSecurity()
  1. IServletWrapper
getServletWrapper()
  1. int
getStartUpWeight()
  1. boolean
isAddedToLoadOnStartup()
  1. boolean
isAsyncSupported()
  1. boolean
isCachingEnabled()
Checks if caching is enabled for the servlet (requires dynacache to be enabled to have desired effect).
  1. boolean
isClassDefined()
  1. boolean
isEnabled()
  1. boolean
isInternal()
Checks if resource should be considered internal.
  1. boolean
isJsp()
  1. boolean
isLoadOnStartup()
Returns whether or not the servlet represented by this config should be loaded at startup.
  1. boolean
isSingleThreadModelServlet()
  1. boolean
isStatisticsEnabled()
Check if performance monitoring statistics are enabled.
  1. boolean
isWeightChanged()
  1. java.lang.Object
removeAttribute(java.lang.Object key)
Remove an attribute for this config
  1. void
setAddedToLoadOnStartup(boolean addedToLoadOnStartup)
  1. void
setAttributes(java.util.Map map)
Set the current attribute map to the passed in parameter
  1. void
setClassName(java.lang.String string)
Set the classname of the servlet that is represented by this config object
  1. void
setDescription(java.lang.String description)
  1. void
setDisplayName(java.lang.String jspRegisteredName)
Set the display name for this config
  1. void
setFileName(java.lang.String jspUri)
Sets the fileName associated with this config
  1. void
setInitParams(java.util.Map map)
Sets the Map of initialization parameters for the servlet associated with this config instance.
  1. void
setInternal(boolean isInternal)
Set whether resource should be considered internal.
  1. void
setIsCachingEnabled(boolean isEnabled)
Set whether caching is enabled for a servlet (requires dynacache to have desired effect).
  1. void
setIsJsp(boolean b)
Sets whether or not this config represents a JSP file.
  1. void
setMappings(java.util.List<java.lang.String> mappings)
  1. void
setMetaData(WebComponentMetaData metaData)
Sets the component metadata associated with this configuration
  1. void
setMultipartBaseLocation(java.io.File location)
  1. void
setServlet(Servlet servlet)
  1. void
setServletClass(java.lang.Class<? extends Servlet> servletClass)
  1. void
setServletContext(ServletContext context)
Associates the given context with this Servlet's config.
  1. void
setServletName(java.lang.String jspRegisteredName)
Set the servletName for this config
  1. void
setServletWrapper(IServletWrapper wrapper)
  1. void
setSingleThreadModelServlet(boolean isSTM)
  1. void
setStartUpWeight(java.lang.Integer integer)
Set the startup weight for the servlet represented by this config.
  1. void
setStatisticsEnabled(boolean value)
Set whether performance monitoring statistics are enabled.

Method Detail

setClassName

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

getFileName

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

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

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

setInitParams

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

setIsJsp

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

setServletContext

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

setServletName

  1. void setServletName(java.lang.String jspRegisteredName)
Set the servletName for this config
Parameters:
jspRegisteredName -

setDisplayName

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

getClassName

  1. java.lang.String getClassName()
Set the classname for the servlet represented by this config
Returns:

setStartUpWeight

  1. void setStartUpWeight(java.lang.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

  1. void addAttribute(java.lang.Object key,
  2. java.lang.Object value)
Add an attribute for this config
Parameters:
key -
value -

setAttributes

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

removeAttribute

  1. java.lang.Object removeAttribute( java.lang.Object key)
Remove an attribute for this config
Parameters:
key -
Returns:

getMetaData

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

setMetaData

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

isCachingEnabled

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

setIsCachingEnabled

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

setStatisticsEnabled

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

isStatisticsEnabled

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

isJsp

  1. boolean isJsp()

getStartUpWeight

  1. int getStartUpWeight()

setDescription

  1. void setDescription(java.lang.String description)

setInternal

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

isInternal

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

isSingleThreadModelServlet

  1. boolean isSingleThreadModelServlet( )

setSingleThreadModelServlet

  1. void setSingleThreadModelServlet( boolean isSTM)

setServletWrapper

  1. void setServletWrapper(IServletWrapper wrapper)

getServletWrapper

  1. IServletWrapper getServletWrapper( )

setServletClass

  1. void setServletClass(java.lang.Class<? extends Servlet> servletClass)

setServlet

  1. void setServlet(Servlet servlet)

getServletClass

  1. java.lang.Class<? extends Servlet> getServletClass( )

getServlet

  1. Servlet getServlet()

setMappings

  1. void setMappings(java.util.List<java.lang.String> mappings)

getMappings

  1. java.util.List<java.lang.String> getMappings( )

isAddedToLoadOnStartup

  1. boolean isAddedToLoadOnStartup( )

isAsyncSupported

  1. boolean isAsyncSupported()

setAddedToLoadOnStartup

  1. void setAddedToLoadOnStartup(boolean addedToLoadOnStartup)

isWeightChanged

  1. boolean isWeightChanged()

getMultipartConfig

  1. MultipartConfigElement getMultipartConfig( )

getMultipartBaseLocation

  1. java.io.File getMultipartBaseLocation( )

setMultipartBaseLocation

  1. void setMultipartBaseLocation(java.io.File location)

addMapping

  1. java.util.Set<java.lang.String> addMapping( IServletConfig.CheckContextInitialized checkContextInitialized,
  2. java.lang.String... mappingURI)

getServletSecurity

  1. ServletSecurityElement getServletSecurity( )

isClassDefined

  1. boolean isClassDefined()

isEnabled

  1. boolean isEnabled()