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 ClassesNested classes/interfaces inherited from interface javax.servlet.Registration
javax.servlet.Registration.DynamicNested classes/interfaces inherited from interface javax.servlet.ServletRegistration
javax.servlet.ServletRegistration.Dynamic -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAttribute(Object key, Object value) Add an attribute for this configaddMapping(IServletConfig.CheckContextInitialized checkContextInitialized, String... mappingURI) Set the classname for the servlet represented by this configReturns the file name that may be associated with this config.Returns the component metadata associated with this configurationjavax.servlet.MultipartConfigElementjavax.servlet.ServletClass<? extends javax.servlet.Servlet>javax.servlet.ServletSecurityElementintbooleanbooleanbooleanChecks if caching is enabled for the servlet (requires dynacache to be enabled to have desired effect).booleanbooleanbooleanChecks if resource should be considered internal.booleanisJsp()booleanReturns whether or not the servlet represented by this config should be loaded at startup.booleanbooleanCheck if performance monitoring statistics are enabled.booleanremoveAttribute(Object key) Remove an attribute for this configvoidsetAddedToLoadOnStartup(boolean addedToLoadOnStartup) voidsetAttributes(Map map) Set the current attribute map to the passed in parametervoidsetClassName(String string) Set the classname of the servlet that is represented by this config objectvoidsetDescription(String description) voidsetDisplayName(String jspRegisteredName) Set the display name for this configvoidsetFileName(String jspUri) Sets the fileName associated with this configvoidsetInitParams(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(List<String> mappings) voidsetMetaData(WebComponentMetaData metaData) Sets the component metadata associated with this configurationvoidsetMultipartBaseLocation(File location) voidsetServlet(javax.servlet.Servlet servlet) voidsetServletClass(Class<? extends javax.servlet.Servlet> servletClass) voidsetServletContext(javax.servlet.ServletContext context) Associates the given context with this Servlet's config.voidsetServletName(String jspRegisteredName) Set the servletName for this configvoidsetServletWrapper(IServletWrapper wrapper) voidsetSingleThreadModelServlet(boolean isSTM) voidsetStartUpWeight(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, setInitParametersMethods inherited from interface javax.servlet.Registration.Dynamic
setAsyncSupportedMethods inherited from interface javax.servlet.ServletConfig
getInitParameter, getInitParameterNames, getServletContext, getServletNameMethods inherited from interface javax.servlet.ServletRegistration
addMapping, getRunAsRoleMethods inherited from interface javax.servlet.ServletRegistration.Dynamic
setLoadOnStartup, setMultipartConfig, setRunAsRole, setServletSecurity
-
Method Details
-
setClassName
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
Sets the fileName associated with this config- Parameters:
jspUri-
-
setInitParams
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
Set the servletName for this config- Parameters:
jspRegisteredName-
-
setDisplayName
Set the display name for this config- Parameters:
jspRegisteredName-
-
getClassName
String getClassName()Set the classname for the servlet represented by this config- Specified by:
getClassNamein interfacejavax.servlet.Registration- Returns:
-
setStartUpWeight
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
Add an attribute for this config- Parameters:
key-value-
-
setAttributes
Set the current attribute map to the passed in parameter- Parameters:
map-
-
removeAttribute
Remove an attribute for this config- Parameters:
key-- Returns:
-
getMetaData
WebComponentMetaData getMetaData()Returns the component metadata associated with this configuration- Returns:
-
setMetaData
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
-
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
-
getServletWrapper
IServletWrapper getServletWrapper() -
setServletClass
-
setServlet
void setServlet(javax.servlet.Servlet servlet) -
getServletClass
Class<? extends javax.servlet.Servlet> getServletClass() -
getServlet
javax.servlet.Servlet getServlet() -
setMappings
-
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
File getMultipartBaseLocation() -
setMultipartBaseLocation
-
addMapping
Set<String> addMapping(IServletConfig.CheckContextInitialized checkContextInitialized, String... mappingURI) -
getServletSecurity
javax.servlet.ServletSecurityElement getServletSecurity() -
isClassDefined
boolean isClassDefined() -
isEnabled
boolean isEnabled()
-