org.eclipse.jetty.server.handler.ResourceHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetty-server Show documentation
Show all versions of jetty-server Show documentation
The core jetty server artifact.
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.server.handler;
import java.time.Duration;
import java.util.List;
import org.eclipse.jetty.http.CompressedContentFormat;
import org.eclipse.jetty.http.FileMappingHttpContentFactory;
import org.eclipse.jetty.http.HttpContent;
import org.eclipse.jetty.http.HttpMethod;
import org.eclipse.jetty.http.MimeTypes;
import org.eclipse.jetty.http.PreCompressedHttpContentFactory;
import org.eclipse.jetty.http.ResourceHttpContentFactory;
import org.eclipse.jetty.http.ValidatingCachingHttpContentFactory;
import org.eclipse.jetty.io.ByteBufferPool;
import org.eclipse.jetty.io.NoopByteBufferPool;
import org.eclipse.jetty.server.Context;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.ResourceService;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.util.URIUtil;
import org.eclipse.jetty.util.resource.Resource;
import org.eclipse.jetty.util.resource.ResourceFactory;
import org.eclipse.jetty.util.resource.Resources;
/**
* 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).
* TODO there is a lot of URI manipulation, this should be factored out in a utility class.
*
* TODO GW: Work out how this logic can be reused by the DefaultServlet... potentially for wrapped output streams
*
* Missing:
* - current context' mime types
* - Default stylesheet (needs Resource impl for classpath resources)
* - request ranges
* - a way to configure caching or not
*/
public class ResourceHandler extends Handler.Wrapper
{
private final ResourceService _resourceService;
private ByteBufferPool _byteBufferPool;
private Resource _resourceBase;
private MimeTypes _mimeTypes;
private List _welcomes = List.of("index.html");
public ResourceHandler()
{
_resourceService = new ResourceService();
}
@Override
public void doStart() throws Exception
{
Context context = ContextHandler.getCurrentContext();
if (_resourceBase == null)
{
if (context != null)
_resourceBase = context.getBaseResource();
}
_mimeTypes = context == null ? MimeTypes.DEFAULTS : context.getMimeTypes();
_byteBufferPool = getByteBufferPool(context);
_resourceService.setHttpContentFactory(newHttpContentFactory());
_resourceService.setWelcomeFactory(setupWelcomeFactory());
if (_resourceService.getStyleSheet() == null)
setStyleSheet(getServer().getDefaultStyleSheet());
super.doStart();
}
private ByteBufferPool getByteBufferPool(Context context)
{
if (context == null)
return new NoopByteBufferPool();
Server server = getServer();
if (server == null)
return new NoopByteBufferPool();
ByteBufferPool byteBufferPool = server.getBean(ByteBufferPool.class);
return (byteBufferPool == null) ? new NoopByteBufferPool() : byteBufferPool;
}
public HttpContent.Factory getHttpContentFactory()
{
return _resourceService.getHttpContentFactory();
}
protected HttpContent.Factory newHttpContentFactory()
{
HttpContent.Factory contentFactory = new ResourceHttpContentFactory(ResourceFactory.of(_resourceBase), _mimeTypes);
contentFactory = new PreCompressedHttpContentFactory(contentFactory, _resourceService.getPrecompressedFormats());
contentFactory = new FileMappingHttpContentFactory(contentFactory);
contentFactory = new ValidatingCachingHttpContentFactory(contentFactory, Duration.ofSeconds(1).toMillis(), _byteBufferPool);
return contentFactory;
}
protected ResourceService.WelcomeFactory setupWelcomeFactory()
{
return request ->
{
if (_welcomes == null)
return null;
for (String welcome : _welcomes)
{
String pathInContext = Request.getPathInContext(request);
String welcomeInContext = URIUtil.addPaths(pathInContext, welcome);
Resource welcomePath = _resourceBase.resolve(pathInContext).resolve(welcome);
if (Resources.isReadableFile(welcomePath))
return welcomeInContext;
}
// not found
return null;
};
}
@Override
public Request.Processor handle(Request request) throws Exception
{
if (!HttpMethod.GET.is(request.getMethod()) && !HttpMethod.HEAD.is(request.getMethod()))
{
// try another handler
return super.handle(request);
}
HttpContent content = _resourceService.getContent(Request.getPathInContext(request), request);
if (content == null)
return super.handle(request); // no content - try other handlers
return (rq, rs, cb) -> _resourceService.doGet(rq, rs, cb, content);
}
/**
* @return Returns the resourceBase.
*/
public Resource getBaseResource()
{
return _resourceBase;
}
/**
* @return the cacheControl header to set on all static content.
*/
public String getCacheControl()
{
return _resourceService.getCacheControl();
}
/**
* @return file extensions that signify that a file is gzip compressed. Eg ".svgz"
*/
public List getGzipEquivalentFileExtensions()
{
return _resourceService.getGzipEquivalentFileExtensions();
}
public MimeTypes getMimeTypes()
{
return _mimeTypes;
}
/**
* @return Returns the stylesheet as a Resource.
*/
public Resource getStyleSheet()
{
return _resourceService.getStyleSheet();
}
public List getWelcomeFiles()
{
return _welcomes;
}
/**
* @return If true, range requests and responses are supported
*/
public boolean isAcceptRanges()
{
return _resourceService.isAcceptRanges();
}
/**
* @return If true, directory listings are returned if no welcome file is found. Else 403 Forbidden.
*/
public boolean isDirAllowed()
{
return _resourceService.isDirAllowed();
}
/**
* @return True if ETag processing is done
*/
public boolean isEtags()
{
return _resourceService.isEtags();
}
/**
* @return Precompressed resources formats that can be used to serve compressed variant of resources.
*/
public List getPrecompressedFormats()
{
return _resourceService.getPrecompressedFormats();
}
/**
* @return If true, welcome files are redirected rather than forwarded to.
*/
public boolean isRedirectWelcome()
{
return _resourceService.isRedirectWelcome();
}
/**
* @param acceptRanges If true, range requests and responses are supported
*/
public void setAcceptRanges(boolean acceptRanges)
{
_resourceService.setAcceptRanges(acceptRanges);
}
/**
* @param base The resourceBase to server content from. If null the
* context resource base is used.
*/
public void setBaseResource(Resource base)
{
if (isStarted())
throw new IllegalStateException(getState());
_resourceBase = base;
}
/**
* @param base The resourceBase to server content from. If null the
* context resource base is used. If non-null the {@link Resource} is created
* from {@link ResourceFactory#of(org.eclipse.jetty.util.component.Container)} for
* this context.
*/
public void setBaseResourceAsString(String base)
{
setBaseResource(base == null ? null : ResourceFactory.of(this).newResource(base));
}
/**
* @param cacheControl the cacheControl header to set on all static content.
*/
public void setCacheControl(String cacheControl)
{
_resourceService.setCacheControl(cacheControl);
}
/**
* @param dirAllowed If true, directory listings are returned if no welcome file is found. Else 403 Forbidden.
*/
public void setDirAllowed(boolean dirAllowed)
{
_resourceService.setDirAllowed(dirAllowed);
}
/**
* @param etags True if ETag processing is done
*/
public void setEtags(boolean etags)
{
_resourceService.setEtags(etags);
}
/**
* @param gzipEquivalentFileExtensions file extensions that signify that a file is gzip compressed. Eg ".svgz"
*/
public void setGzipEquivalentFileExtensions(List gzipEquivalentFileExtensions)
{
_resourceService.setGzipEquivalentFileExtensions(gzipEquivalentFileExtensions);
}
/**
* @param 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.
*/
public void setPrecompressedFormats(CompressedContentFormat... precompressedFormats)
{
setPrecompressedFormats(List.of(precompressedFormats));
}
/**
* @param 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.
*/
public void setPrecompressedFormats(List precompressedFormats)
{
_resourceService.setPrecompressedFormats(precompressedFormats);
}
public void setEncodingCacheSize(int encodingCacheSize)
{
_resourceService.setEncodingCacheSize(encodingCacheSize);
}
public int getEncodingCacheSize()
{
return _resourceService.getEncodingCacheSize();
}
/**
* @param redirectWelcome If true, welcome files are redirected rather than forwarded to.
* redirection is always used if the ResourceHandler is not scoped by
* a ContextHandler
*/
public void setRedirectWelcome(boolean redirectWelcome)
{
_resourceService.setRedirectWelcome(redirectWelcome);
}
/**
* @param styleSheet The location of the style sheet to be used as a String.
*/
public void setStyleSheet(Resource styleSheet)
{
_resourceService.setStyleSheet(styleSheet);
}
public void setWelcomeFiles(String... welcomeFiles)
{
setWelcomeFiles(List.of(welcomeFiles));
}
public void setWelcomeFiles(List welcomeFiles)
{
_welcomes = welcomeFiles;
}
/**
* Utility class to create a ContextHandler containing a ResourceHandler.
*/
public static class ResourceContext extends ContextHandler
{
{
setHandler(new ResourceHandler());
}
}
}