public class DefaultServlet extends HttpServlet implements ResourceFactory, ResourceService.WelcomeFactory
This servlet, normally mapped to /, provides the handling for static content, OPTION and TRACE methods for the context. The following initParameters are supported, these can be set either on the servlet itself or as ServletContext initParameters with a prefix of org.eclipse.jetty.servlet.Default. :
acceptRanges If true, range requests and responses are supported dirAllowed If true, directory listings are returned if no welcome file is found. Else 403 Forbidden. welcomeServlets If true, attempt to dispatch to welcome files that are servlets, but only after no matching static resources could be found. If false, then a welcome file must exist on disk. If "exact", then exact servlet matches are supported without an existing file. Default is true. This must be false if you want directory listings, but have index.jsp in your welcome file list. redirectWelcome If true, welcome files are redirected rather than forwarded to. gzip If set to true, then static content will be served as gzip content encoded if a matching resource is found ending with ".gz" (default false) (deprecated: use precompressed) precompressed If set to a comma separated list of encoding types (that may be listed in a requests Accept-Encoding header) to file extension mappings to look for and serve. For example: "br=.br,gzip=.gz,bzip2=.bz". If set to a boolean True, then a default set of compressed formats will be used, otherwise no precompressed formats. resourceBase Set to replace the context resource base resourceCache If set, this is a context attribute name, which the servlet will use to look for a shared ResourceCache instance. relativeResourceBase Set with a pathname relative to the base of the servlet context root. Useful for only serving static content out of only specific subdirectories. pathInfoOnly If true, only the path info will be applied to the resourceBase stylesheet Set with the location of an optional stylesheet that will be used to decorate the directory listing html. etags If True, weak etags will be generated and handled. maxCacheSize The maximum total size of the cache or 0 for no cache. maxCachedFileSize The maximum size of a file to cache maxCachedFiles The maximum number of files to cache useFileMappedBuffer If set to true, it will use mapped file buffer to serve static content when using NIO connector. Setting this value to false means that a direct buffer will be used instead of a mapped file buffer. This is set to false by default by this class, but may be overridden by eg webdefault.xml cacheControl If set, all static content will have this value set as the cache-control header. otherGzipFileExtensions Other file extensions that signify that a file is already compressed. Eg ".svgz" encodingHeaderCacheSize Max entries in a cache of ACCEPT-ENCODING headers.
Modifier and Type | Field and Description |
---|---|
static String |
CONTEXT_INIT |
Constructor and Description |
---|
DefaultServlet() |
DefaultServlet(ResourceService resourceService) |
Modifier and Type | Method and Description |
---|---|
void |
destroy() |
String |
getInitParameter(String name) |
Resource |
getResource(String pathInContext)
get Resource to serve.
|
String |
getWelcomeFile(String pathInContext)
Finds a matching welcome file for the supplied
Resource . |
void |
init() |
service
getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log
public static final String CONTEXT_INIT
public DefaultServlet(ResourceService resourceService)
public DefaultServlet()
public void init() throws UnavailableException
init
in class GenericServlet
UnavailableException
public String getInitParameter(String name)
getInitParameter
in interface ServletConfig
getInitParameter
in class GenericServlet
public Resource getResource(String pathInContext)
getResource
in interface ResourceFactory
pathInContext
- The path to find a resource for.public void destroy()
destroy
in interface Servlet
destroy
in class GenericServlet
public String getWelcomeFile(String pathInContext)
ResourceService.WelcomeFactory
Resource
.getWelcomeFile
in interface ResourceService.WelcomeFactory
pathInContext
- the path of the requestCopyright © 2010 - 2020 Adobe. All Rights Reserved