Package org.eclipse.jetty.server.handler

Class ResourceHandler

java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
org.eclipse.jetty.util.component.ContainerLifeCycle
org.eclipse.jetty.server.handler.AbstractHandler
org.eclipse.jetty.server.handler.AbstractHandlerContainer
org.eclipse.jetty.server.handler.HandlerWrapper
org.eclipse.jetty.server.handler.ResourceHandler
All Implemented Interfaces:
Handler, HandlerContainer, ResourceService.WelcomeFactory, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, ResourceFactory
@Deprecated(since="2021-05-27") public class ResourceHandler extends HandlerWrapper implements ResourceFactory, ResourceService.WelcomeFactory
Deprecated.
The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
Resource Handler. This handle will serve static content and handle If-Modified-Since headers. No caching is done. Requests for resources that do not exist are let pass (Eg no 404's).

  • Constructor Details

    • ResourceHandler

      public ResourceHandler(ResourceService resourceService)
      Deprecated.

    • ResourceHandler

      public ResourceHandler()
      Deprecated.

  • Method Details

    • getWelcomeFile

      public String getWelcomeFile(String pathInContext)
      Deprecated.
      Description copied from interface: ResourceService.WelcomeFactory
      Finds a matching welcome file for the supplied Resource.
      Specified by:
      getWelcomeFile in interface ResourceService.WelcomeFactory
      Parameters:
      pathInContext - the path of the request
      Returns:
      The path of the matching welcome file in context or null.

    • doStart

      public void doStart() throws Exception
      Deprecated.
      Throws:
      Exception

    • getBaseResource

      public Resource getBaseResource()
      Deprecated.
      Returns:
      Returns the resourceBase.

    • getCacheControl

      public String getCacheControl()
      Deprecated.
      Returns:
      the cacheControl header to set on all static content.

    • getGzipEquivalentFileExtensions

      public List<String> getGzipEquivalentFileExtensions()
      Deprecated.
      Returns:
      file extensions that signify that a file is gzip compressed. Eg ".svgz"

    • getMimeTypes

      public MimeTypes getMimeTypes()
      Deprecated.

    • getMinAsyncContentLength

      @Deprecated public int getMinAsyncContentLength()
      Deprecated.
      Get the minimum content length for async handling.
      Returns:
      The minimum size in bytes of the content before asynchronous handling is used, or -1 for no async handling or 0 (default) for using ServletResponse.getBufferSize() as the minimum length.

    • getMinMemoryMappedContentLength

      @Deprecated public int getMinMemoryMappedContentLength()
      Deprecated.
      Get minimum memory mapped file content length.
      Returns:
      the minimum size in bytes of a file resource that will be served using a memory mapped buffer, or -1 (default) for no memory mapped buffers.

    • getResource

      public Resource getResource(String path)
      Deprecated.
      Description copied from interface: ResourceFactory
      Get a resource for a path.
      Specified by:
      getResource in interface ResourceFactory
      Parameters:
      path - The path to the resource
      Returns:
      The resource or null

    • getResourceBase

      public String getResourceBase()
      Deprecated.
      Returns:
      Returns the base resource as a string.

    • getStylesheet

      public Resource getStylesheet()
      Deprecated.
      Returns:
      Returns the stylesheet as a Resource.

    • getDefaultStylesheet

      public static Resource getDefaultStylesheet()
      Deprecated.

    • getWelcomeFiles

      public String[] getWelcomeFiles()
      Deprecated.

    • handle

      public void handle(String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException
      Deprecated.
      Description copied from interface: Handler
      Handle a request.
      Specified by:
      handle in interface Handler
      Overrides:
      handle in class HandlerWrapper
      Parameters:
      target - The target of the request - either a URI or a name.
      baseRequest - The original unwrapped request object.
      request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.
      response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.
      Throws:
      IOException - if unable to handle the request or response processing
      ServletException - if unable to handle the request or response due to underlying servlet issue

    • isAcceptRanges

      public boolean isAcceptRanges()
      Deprecated.
      Returns:
      If true, range requests and responses are supported

    • isDirAllowed

      public boolean isDirAllowed()
      Deprecated.
      Returns:
      If true, directory listings are returned if no welcome file is found. Else 403 Forbidden.

    • isDirectoriesListed

      public boolean isDirectoriesListed()
      Deprecated.
      Get the directory option.
      Returns:
      true if directories are listed.

    • isEtags

      public boolean isEtags()
      Deprecated.
      Returns:
      True if ETag processing is done

    • isGzip

      @Deprecated public boolean isGzip()
      Deprecated.
      Returns:
      If set to true, then static content will be served as gzip content encoded if a matching resource is found ending with ".gz"

    • getPrecompressedFormats

      public CompressedContentFormat[] getPrecompressedFormats()
      Deprecated.
      Returns:
      Precompressed resources formats that can be used to serve compressed variant of resources.

    • isPathInfoOnly

      public boolean isPathInfoOnly()
      Deprecated.
      Returns:
      true, only the path info will be applied to the resourceBase

    • isRedirectWelcome

      public boolean isRedirectWelcome()
      Deprecated.
      Returns:
      If true, welcome files are redirected rather than forwarded to.

    • setAcceptRanges

      public void setAcceptRanges(boolean acceptRanges)
      Deprecated.
      Parameters:
      acceptRanges - If true, range requests and responses are supported

    • setBaseResource

      public void setBaseResource(Resource base)
      Deprecated.
      Parameters:
      base - The resourceBase to server content from. If null the context resource base is used.

    • setCacheControl

      public void setCacheControl(String cacheControl)
      Deprecated.
      Parameters:
      cacheControl - the cacheControl header to set on all static content.

    • setDirAllowed

      public void setDirAllowed(boolean dirAllowed)
      Deprecated.
      Parameters:
      dirAllowed - If true, directory listings are returned if no welcome file is found. Else 403 Forbidden.

    • setDirectoriesListed

      public void setDirectoriesListed(boolean directory)
      Deprecated.
      Set the directory.
      Parameters:
      directory - true if directories are listed.

    • setEtags

      public void setEtags(boolean etags)
      Deprecated.
      Parameters:
      etags - True if ETag processing is done

    • setGzip

      @Deprecated public void setGzip(boolean gzip)
      Deprecated.
      Parameters:
      gzip - If set to true, then static content will be served as gzip content encoded if a matching resource is found ending with ".gz"

    • setGzipEquivalentFileExtensions

      public void setGzipEquivalentFileExtensions(List<String> gzipEquivalentFileExtensions)
      Deprecated.
      Parameters:
      gzipEquivalentFileExtensions - file extensions that signify that a file is gzip compressed. Eg ".svgz"

    • setPrecompressedFormats

      public void setPrecompressedFormats(CompressedContentFormat[] precompressedFormats)
      Deprecated.
      Parameters:
      precompressedFormats - The list of precompresed formats to serve in encoded format if matching resource found. For example serve gzip encoded file if ".gz" suffixed resource is found.

    • setMimeTypes

      public void setMimeTypes(MimeTypes mimeTypes)
      Deprecated.

    • setMinAsyncContentLength

      @Deprecated public void setMinAsyncContentLength(int minAsyncContentLength)
      Deprecated.
      Set the minimum content length for async handling.
      Parameters:
      minAsyncContentLength - The minimum size in bytes of the content before asynchronous handling is used, or -1 for no async handling or 0 for using ServletResponse.getBufferSize() as the minimum length.

    • setMinMemoryMappedContentLength

      @Deprecated public void setMinMemoryMappedContentLength(int minMemoryMappedFileSize)
      Deprecated.
      Set minimum memory mapped file content length.
      Parameters:
      minMemoryMappedFileSize - the minimum size in bytes of a file resource that will be served using a memory mapped buffer, or -1 for no memory mapped buffers.

    • setPathInfoOnly

      public void setPathInfoOnly(boolean pathInfoOnly)
      Deprecated.
      Parameters:
      pathInfoOnly - true, only the path info will be applied to the resourceBase

    • setRedirectWelcome

      public void setRedirectWelcome(boolean redirectWelcome)
      Deprecated.
      Parameters:
      redirectWelcome - If true, welcome files are redirected rather than forwarded to. redirection is always used if the ResourceHandler is not scoped by a ContextHandler

    • setResourceBase

      public void setResourceBase(String resourceBase)
      Deprecated.
      Parameters:
      resourceBase - The base resource as a string.

    • setStylesheet

      public void setStylesheet(String stylesheet)
      Deprecated.
      Parameters:
      stylesheet - The location of the stylesheet to be used as a String.

    • setWelcomeFiles

      public void setWelcomeFiles(String[] welcomeFiles)
      Deprecated.