Module org.eclipse.jetty.server

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.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ResourceHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, 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.thread.Invocable

public class ResourceHandler
extends Handler.Wrapper

Resource Handler 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

Modifier and Type	Class	Description
static class	ResourceHandler.ResourceContext	Utility class to create a ContextHandler containing a ResourceHandler.

Nested classes/interfaces inherited from class org.eclipse.jetty.server.Handler.Abstract

Handler.Abstract.NonBlocking

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.server.Handler

Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

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

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

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler

Request.Handler.AbortException

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

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
ResourceHandler()
ResourceHandler(Handler handler)

Method Summary

Modifier and Type	Method	Description
void	doStart()
org.eclipse.jetty.util.resource.Resource	getBaseResource()
org.eclipse.jetty.io.ByteBufferPool	getByteBufferPool()
String	getCacheControl()	Get the cacheControl header to set on all static content..
int	getEncodingCacheSize()
List<String>	getGzipEquivalentFileExtensions()
org.eclipse.jetty.http.content.HttpContent.Factory	getHttpContentFactory()
org.eclipse.jetty.http.MimeTypes	getMimeTypes()
List<org.eclipse.jetty.http.CompressedContentFormat>	getPrecompressedFormats()
ResourceService	getResourceService()
org.eclipse.jetty.util.resource.Resource	getStyleSheet()
List<String>	getWelcomeFiles()
ResourceService.WelcomeMode	getWelcomeMode()
boolean	handle(Request request, Response response, org.eclipse.jetty.util.Callback callback)	Invoked to handle the passed HTTP request and response.
boolean	isAcceptRanges()
boolean	isDirAllowed()
boolean	isEtags()
boolean	isUseFileMapping()
protected org.eclipse.jetty.http.content.HttpContent.Factory	newHttpContentFactory()
protected ResourceService	newResourceService()
void	setAcceptRanges(boolean acceptRanges)
void	setBaseResource(org.eclipse.jetty.util.resource.Resource base)
void	setBaseResourceAsString(String base)
void	setCacheControl(String cacheControl)	Set the cacheControl header to set on all static content..
void	setDirAllowed(boolean dirAllowed)
void	setEncodingCacheSize(int encodingCacheSize)
void	setEtags(boolean etags)
void	setGzipEquivalentFileExtensions(List<String> gzipEquivalentFileExtensions)	Set file extensions that signify that a file is gzip compressed.
void	setMimeTypes(org.eclipse.jetty.http.MimeTypes mimeTypes)
void	setPrecompressedFormats(List<org.eclipse.jetty.http.CompressedContentFormat> precompressedFormats)
void	setPrecompressedFormats(org.eclipse.jetty.http.CompressedContentFormat... precompressedFormats)
void	setStyleSheet(org.eclipse.jetty.util.resource.Resource styleSheet)
protected ResourceService.WelcomeFactory	setupWelcomeFactory()
void	setUseFileMapping(boolean useFileMapping)
void	setWelcomeFiles(String... welcomeFiles)
void	setWelcomeFiles(List<String> welcomeFiles)
void	setWelcomeMode(ResourceService.WelcomeMode welcomeMode)

Methods inherited from class org.eclipse.jetty.server.Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class org.eclipse.jetty.server.Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class org.eclipse.jetty.server.Handler.Abstract

destroy, doStop, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.Container

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.util.component.Destroyable

destroy

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.server.Handler

getServer, setServer

Methods inherited from interface org.eclipse.jetty.server.Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface org.eclipse.jetty.server.Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

ResourceHandler

public ResourceHandler()

ResourceHandler

public ResourceHandler(Handler handler)

Method Details

newResourceService

protected ResourceService newResourceService()

getResourceService

public ResourceService getResourceService()

doStart

public void doStart()
             throws Exception

Overrides:

doStart in class Handler.Abstract

Throws:

Exception

getHttpContentFactory

public org.eclipse.jetty.http.content.HttpContent.Factory getHttpContentFactory()

newHttpContentFactory

protected org.eclipse.jetty.http.content.HttpContent.Factory newHttpContentFactory()

setupWelcomeFactory

protected ResourceService.WelcomeFactory setupWelcomeFactory()

handle

public boolean handle(Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)
               throws Exception

Description copied from interface: Request.Handler

Invoked to handle the passed HTTP request and response.

The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

The simplest implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }
 

A HelloWorld implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
 

Specified by:

handle in interface Request.Handler

Overrides:

handle in class Handler.Wrapper

Parameters:

request - the HTTP request to handle

response - the HTTP response to handle

callback - the callback to complete when the handling is complete

Returns:

True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.

Throws:

Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.

See Also:

• Request.Handler.AbortException

getBaseResource

public org.eclipse.jetty.util.resource.Resource getBaseResource()

Returns:

Returns the resourceBase.

getByteBufferPool

public org.eclipse.jetty.io.ByteBufferPool getByteBufferPool()

getCacheControl

public String getCacheControl()

Get the cacheControl header to set on all static content..

Returns:

the cacheControl header to set on all static content.

getGzipEquivalentFileExtensions

public List<String> getGzipEquivalentFileExtensions()

Returns:

file extensions that signify that a file is gzip compressed. Eg ".svgz"

getMimeTypes

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

getStyleSheet

public org.eclipse.jetty.util.resource.Resource getStyleSheet()

Returns:

Returns the stylesheet as a Resource.

getWelcomeFiles

public List<String> getWelcomeFiles()

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.

isEtags

public boolean isEtags()

Returns:

True if ETag processing is done

isUseFileMapping

public boolean isUseFileMapping()

getPrecompressedFormats

public List<org.eclipse.jetty.http.CompressedContentFormat> getPrecompressedFormats()

Returns:

Precompressed resources formats that can be used to serve compressed variant of resources.

getWelcomeMode

public ResourceService.WelcomeMode getWelcomeMode()

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.

setBaseResourceAsString

public void setBaseResourceAsString(String base)

Parameters:

base - The resourceBase to server content from. If null the context resource base is used. If non-null the Resource is created from ResourceFactory.of(org.eclipse.jetty.util.component.Container) for this context.

setCacheControl

public void setCacheControl(String cacheControl)

Set the cacheControl header to set on all static content..

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.

setEtags

public void setEtags(boolean etags)

Parameters:

etags - True if ETag processing is done

setGzipEquivalentFileExtensions

public void setGzipEquivalentFileExtensions(List<String> gzipEquivalentFileExtensions)

Set file extensions that signify that a file is gzip compressed. Eg ".svgz".

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.

setPrecompressedFormats

public void setPrecompressedFormats(List<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.

setEncodingCacheSize

public void setEncodingCacheSize(int encodingCacheSize)

getEncodingCacheSize

public int getEncodingCacheSize()

setMimeTypes

public void setMimeTypes(org.eclipse.jetty.http.MimeTypes mimeTypes)

setUseFileMapping

public void setUseFileMapping(boolean useFileMapping)

setWelcomeMode

public void setWelcomeMode(ResourceService.WelcomeMode welcomeMode)

setStyleSheet

public void setStyleSheet(org.eclipse.jetty.util.resource.Resource styleSheet)

Parameters:

styleSheet - The location of the style sheet to be used as a String.

setWelcomeFiles

public void setWelcomeFiles(String... welcomeFiles)

setWelcomeFiles

public void setWelcomeFiles(List<String> welcomeFiles)