Module org.eclipse.jetty.server
Package org.eclipse.jetty.server.handler

Class ResourceHandler

  • All Implemented Interfaces:
    Handler, HandlerContainer, ResourceService.WelcomeFactory, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.util.resource.ResourceFactory
    public class ResourceHandler
extends HandlerWrapper
implements org.eclipse.jetty.util.resource.ResourceFactory, ResourceService.WelcomeFactory
    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).

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener, org.eclipse.jetty.util.component.AbstractLifeCycle.StopException

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

        org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

        org.eclipse.jetty.util.component.Dumpable.DumpableContainer

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • Field Summary

      • Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        FAILED, STARTED, STARTING, STOPPED, STOPPING

      • Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

        KEY

    • Constructor Detail

      • ResourceHandler

        public ResourceHandler​(ResourceService resourceService)

      • ResourceHandler

        public ResourceHandler()

    • Method Detail

      • getWelcomeFile

        public java.lang.String getWelcomeFile​(java.lang.String pathInContext)
                                throws java.io.IOException
        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.
        Throws:
        java.io.IOException

      • doStart

        public void doStart()
             throws java.lang.Exception
        Overrides:
        doStart in class AbstractHandler
        Throws:
        java.lang.Exception

      • getBaseResource

        public org.eclipse.jetty.util.resource.Resource getBaseResource()
        Returns:
        Returns the resourceBase.

      • getCacheControl

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

      • getGzipEquivalentFileExtensions

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

      • getMimeTypes

        public org.eclipse.jetty.http.MimeTypes getMimeTypes()

      • getResource

        public org.eclipse.jetty.util.resource.Resource getResource​(java.lang.String path)
                                                     throws java.io.IOException
        Specified by:
        getResource in interface org.eclipse.jetty.util.resource.ResourceFactory
        Throws:
        java.io.IOException

      • getResourceBase

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

      • getStylesheet

        public org.eclipse.jetty.util.resource.Resource getStylesheet()
        Returns:
        Returns the stylesheet as a Resource.

      • getDefaultStylesheet

        public static org.eclipse.jetty.util.resource.Resource getDefaultStylesheet()

      • getWelcomeFiles

        public java.lang.String[] getWelcomeFiles()

      • handle

        public void handle​(java.lang.String target,
                   Request baseRequest,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.io.IOException,
                   javax.servlet.ServletException
        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:
        java.io.IOException - if unable to handle the request or response processing
        javax.servlet.ServletException - if unable to handle the request or response due to underlying servlet issue

      • isAcceptRanges

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

      • isDirAllowed

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

      • isDirectoriesListed

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

      • isEtags

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

      • getPrecompressedFormats

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

      • isPathInfoOnly

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

      • isRedirectWelcome

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

      • setAcceptRanges

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

      • setBaseResource

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

      • setCacheControl

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

      • setDirAllowed

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

      • setDirectoriesListed

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

      • setEtags

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

      • setGzipEquivalentFileExtensions

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

      • setPrecompressedFormats

        public void setPrecompressedFormats​(org.eclipse.jetty.http.CompressedContentFormat[] precompressedFormats)
        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​(org.eclipse.jetty.http.MimeTypes mimeTypes)

      • setPathInfoOnly

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

      • setRedirectWelcome

        public void setRedirectWelcome​(boolean redirectWelcome)
        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​(java.lang.String resourceBase)
        Parameters:
        resourceBase - The base resource as a string.

      • setStylesheet

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

      • setWelcomeFiles

        public void setWelcomeFiles​(java.lang.String[] welcomeFiles)