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
Nested Classes Modifier and Type Interface Description static classIServletConfig.CheckContextInitialized
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddAttribute(java.lang.Object key, java.lang.Object value)Add an attribute for this configjava.util.Set<java.lang.String>addMapping(IServletConfig.CheckContextInitialized checkContextInitialized, java.lang.String... mappingURI)java.lang.StringgetClassName()Set the classname for the servlet represented by this configjava.lang.StringgetFileName()Returns the file name that may be associated with this config.java.util.List<java.lang.String>getMappings()WebComponentMetaDatagetMetaData()Returns the component metadata associated with this configurationjava.io.FilegetMultipartBaseLocation()javax.servlet.MultipartConfigElementgetMultipartConfig()javax.servlet.ServletgetServlet()java.lang.Class<? extends javax.servlet.Servlet>getServletClass()javax.servlet.ServletSecurityElementgetServletSecurity()IServletWrappergetServletWrapper()intgetStartUpWeight()booleanisAddedToLoadOnStartup()booleanisAsyncSupported()booleanisCachingEnabled()Checks if caching is enabled for the servlet (requires dynacache to be enabled to have desired effect).booleanisClassDefined()booleanisEnabled()booleanisInternal()Checks if resource should be considered internal.booleanisJsp()booleanisLoadOnStartup()Returns whether or not the servlet represented by this config should be loaded at startup.booleanisSingleThreadModelServlet()booleanisStatisticsEnabled()Check if performance monitoring statistics are enabled.booleanisWeightChanged()java.lang.ObjectremoveAttribute(java.lang.Object key)Remove an attribute for this configvoidsetAddedToLoadOnStartup(boolean addedToLoadOnStartup)voidsetAttributes(java.util.Map map)Set the current attribute map to the passed in parametervoidsetClassName(java.lang.String string)Set the classname of the servlet that is represented by this config objectvoidsetDescription(java.lang.String description)voidsetDisplayName(java.lang.String jspRegisteredName)Set the display name for this configvoidsetFileName(java.lang.String jspUri)Sets the fileName associated with this configvoidsetInitParams(java.util.Map map)Sets the Map of initialization parameters for the servlet associated with this config instance.voidsetInternal(boolean isInternal)Set whether resource should be considered internal.voidsetIsCachingEnabled(boolean isEnabled)Set whether caching is enabled for a servlet (requires dynacache to have desired effect).voidsetIsJsp(boolean b)Sets whether or not this config represents a JSP file.voidsetMappings(java.util.List<java.lang.String> mappings)voidsetMetaData(WebComponentMetaData metaData)Sets the component metadata associated with this configurationvoidsetMultipartBaseLocation(java.io.File location)voidsetServlet(javax.servlet.Servlet servlet)voidsetServletClass(java.lang.Class<? extends javax.servlet.Servlet> servletClass)voidsetServletContext(javax.servlet.ServletContext context)Associates the given context with this Servlet's config.voidsetServletName(java.lang.String jspRegisteredName)Set the servletName for this configvoidsetServletWrapper(IServletWrapper wrapper)voidsetSingleThreadModelServlet(boolean isSTM)voidsetStartUpWeight(java.lang.Integer integer)Set the startup weight for the servlet represented by this config.voidsetStatisticsEnabled(boolean value)Set whether performance monitoring statistics are enabled.-
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:
getClassNamein interfacejavax.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:
getMappingsin interfacejavax.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()
-
-