com.ibm.wsspi.webcontainer.servlet
Interface IServletConfig

All Superinterfaces:
javax.servlet.Registration, javax.servlet.Registration.Dynamic, javax.servlet.ServletConfig, javax.servlet.ServletRegistration, javax.servlet.ServletRegistration.Dynamic

public interface IServletConfig
extends javax.servlet.ServletConfig, javax.servlet.ServletRegistration.Dynamic


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

Method Detail

setClassName

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

Parameters:
string -

getFileName

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

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(java.lang.String jspUri)
Sets the fileName associated with this config

Parameters:
jspUri -

setInitParams

void setInitParams(java.util.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(javax.servlet.ServletContext context)
Associates the given context with this Servlet's config.

Parameters:
context -

setServletName

void setServletName(java.lang.String jspRegisteredName)
Set the servletName for this config

Parameters:
jspRegisteredName -

setDisplayName

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

Parameters:
jspRegisteredName -

getClassName

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

Specified by:
getClassName in interface javax.servlet.Registration
Returns:

setStartUpWeight

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

void addAttribute(java.lang.Object key,
                  java.lang.Object value)
Add an attribute for this config

Parameters:
key -
value -

setAttributes

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

Parameters:
map -

removeAttribute

java.lang.Object removeAttribute(java.lang.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(java.lang.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(java.lang.Class<? extends javax.servlet.Servlet> servletClass)

setServlet

void setServlet(javax.servlet.Servlet servlet)

getServletClass

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

getServlet

javax.servlet.Servlet getServlet()

setMappings

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

getMappings

java.util.List<java.lang.String> getMappings()
Specified by:
getMappings in interface javax.servlet.ServletRegistration

isAddedToLoadOnStartup

boolean isAddedToLoadOnStartup()

isAsyncSupported

boolean isAsyncSupported()

setAddedToLoadOnStartup

void setAddedToLoadOnStartup(boolean addedToLoadOnStartup)

isWeightChanged

boolean isWeightChanged()

getMultipartConfig

javax.servlet.MultipartConfigElement getMultipartConfig()

getMultipartBaseLocation

java.io.File getMultipartBaseLocation()

setMultipartBaseLocation

void setMultipartBaseLocation(java.io.File location)

addMapping

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

getServletSecurity

javax.servlet.ServletSecurityElement getServletSecurity()

isClassDefined

boolean isClassDefined()

isEnabled

boolean isEnabled()