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

Modifier and Type	Field and Description
private Resource	_baseResource
private ByteBufferPool	_byteBufferPool
private MimeTypes	_mimeTypes
private final ResourceService	_resourceService
private Resource	_styleSheet
private boolean	_useFileMapping
private List<String>	_welcomes

Access	Constructor and Description
public	ResourceHandler()
public	ResourceHandler(Handler handler)

Method Summary

Modifier and Type	Method and Description
public void	doStart() Overrides org.eclipse.jetty.server.Handler.Abstract.doStart. Starts the managed lifecycle beans in the order they were added.
public Resource	Returns: Returns the resourceBase. getBaseResource()
private ByteBufferPool	getByteBufferPool(Context context)
public ByteBufferPool	getByteBufferPool()
public String	Returns: the cacheControl header to set on all static content. getCacheControl() Get the cacheControl header to set on all static content..
public int	getEncodingCacheSize()
public List<String>	Returns: file extensions that signify that a file is gzip compressed. Eg ".svgz" getGzipEquivalentFileExtensions()
public HttpContent.Factory	getHttpContentFactory()
public MimeTypes	getMimeTypes()
public List<CompressedContentFormat>	Returns: Precompressed resources formats that can be used to serve compressed variant of resources. getPrecompressedFormats()
public ResourceService	getResourceService()
public Resource	Returns: Returns the stylesheet as a Resource. getStyleSheet()
public List<String>	getWelcomeFiles()
public ResourceService.WelcomeMode	getWelcomeMode()
public boolean	handle(Request the HTTP request to handle request, Response the HTTP response to handle response, Callback the callback to complete when the handling is complete callback) Overrides org.eclipse.jetty.server.Handler.Wrapper.handle. Implements org.eclipse.jetty.server.Request.Handler.handle. Invoked to handle the passed HTTP request and response.
public boolean	Returns: If true, range requests and responses are supported isAcceptRanges()
public boolean	Returns: If true, directory listings are returned if no welcome file is found. Else 403 Forbidden. isDirAllowed()
public boolean	Returns: True if ETag processing is done isEtags()
public boolean	isUseFileMapping()
protected HttpContent.Factory	newHttpContentFactory()
protected ResourceService	newResourceService()
public void	setAcceptRanges(boolean If true, range requests and responses are supported acceptRanges)
public void	setBaseResource(Resource The resourceBase to server content from. If null the context resource base is used. base)
public void	setBaseResourceAsString(String 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. base)
public void	setCacheControl(String the cacheControl header to set on all static content. cacheControl) Set the cacheControl header to set on all static content..
public void	setDirAllowed(boolean If true, directory listings are returned if no welcome file is found. Else 403 Forbidden. dirAllowed)
public void	setEncodingCacheSize(int encodingCacheSize)
public void	setEtags(boolean True if ETag processing is done etags)
public void	setGzipEquivalentFileExtensions(List<String> file extensions that signify that a file is gzip compressed. Eg ".svgz" gzipEquivalentFileExtensions) Set file extensions that signify that a file is gzip compressed.
public void	setMimeTypes(MimeTypes mimeTypes)
public void	setPrecompressedFormats(CompressedContentFormat... 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. precompressedFormats)
public void	setPrecompressedFormats(List<CompressedContentFormat> 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. precompressedFormats)
public void	setStyleSheet(Resource The location of the style sheet to be used as a String. styleSheet)
protected ResourceService.WelcomeFactory	setupWelcomeFactory()
public void	setUseFileMapping(boolean useFileMapping)
public void	setWelcomeFiles(String... welcomeFiles)
public void	setWelcomeFiles(List<String> welcomeFiles)
public void	setWelcomeMode(ResourceService.WelcomeMode welcomeMode)

Inherited from org.eclipse.jetty.server.Handler.Wrapper:: getHandler getInvocationType setHandler

Field Detail

_baseResource	back to summary
private Resource _baseResource

_byteBufferPool	back to summary
private ByteBufferPool _byteBufferPool

_mimeTypes	back to summary
private MimeTypes _mimeTypes

_resourceService	back to summary
private final ResourceService _resourceService

_styleSheet	back to summary
private Resource _styleSheet

_useFileMapping	back to summary
private boolean _useFileMapping

_welcomes	back to summary
private List<String> _welcomes

Constructor Detail

ResourceHandler	back to summary
public ResourceHandler()

ResourceHandler	back to summary
public ResourceHandler(Handler handler)

Method Detail

doStart	back to summary
public void doStart() throws Exception Overrides org.eclipse.jetty.server.Handler.Abstract.doStart. Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart. Starts the managed lifecycle beans in the order they were added. Annotations @Override Exceptions Exception: Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart. If there was a problem starting. Will cause a transition to FAILED state

doStart

back to summary

public void doStart() throws Exception

Overrides org.eclipse.jetty.server.Handler.Abstract.doStart.

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

Starts the managed lifecycle beans in the order they were added.

Annotations

@Override

Exceptions

Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

If there was a problem starting. Will cause a transition to FAILED state

getBaseResource	back to summary
public Resource getBaseResource() Returns:Resource Returns the resourceBase.

getByteBufferPool	back to summary
private ByteBufferPool getByteBufferPool(Context context)

getByteBufferPool	back to summary
public ByteBufferPool getByteBufferPool()

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

getCacheControl

back to summary

public String getCacheControl()

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

Returns:String: the cacheControl header to set on all static content.

getEncodingCacheSize	back to summary
public int getEncodingCacheSize()

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

getHttpContentFactory	back to summary
public HttpContent.Factory getHttpContentFactory()

getMimeTypes	back to summary
public MimeTypes getMimeTypes()

getPrecompressedFormats	back to summary
public List<CompressedContentFormat> getPrecompressedFormats() Returns:List<CompressedContentFormat> Precompressed resources formats that can be used to serve compressed variant of resources.

getResourceService	back to summary
public ResourceService getResourceService()

getStyleSheet	back to summary
public Resource getStyleSheet() Returns:Resource Returns the stylesheet as a Resource.

getWelcomeFiles	back to summary
public List<String> getWelcomeFiles()

getWelcomeMode	back to summary
public ResourceService.WelcomeMode getWelcomeMode()

handle back to summary

handle	back to summary
public boolean handle(Request request, Response response, Callback callback) throws Exception Overrides org.eclipse.jetty.server.Handler.Wrapper.handle. Implements org.eclipse.jetty.server.Request.Handler.handle. Doc from org.eclipse.jetty.server.Request.Handler.handle. 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; } Parameters request:Request the HTTP request to handle response:Response the HTTP response to handle callback:Callback the callback to complete when the handling is complete Returns:boolean 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. Annotations @Override Exceptions 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.

public boolean handle(Request request, Response response, Callback callback) throws Exception

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

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;
}

Parameters

request:Request: the HTTP request to handle
response:Response: the HTTP response to handle
callback:Callback: the callback to complete when the handling is complete

Returns:boolean

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.

Annotations

@Override

Exceptions

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.

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

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

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

isUseFileMapping	back to summary
public boolean isUseFileMapping()

newHttpContentFactory	back to summary
protected HttpContent.Factory newHttpContentFactory()

newResourceService	back to summary
protected ResourceService newResourceService()

setAcceptRanges	back to summary
public void setAcceptRanges(boolean acceptRanges) Parameters acceptRanges:boolean If true, range requests and responses are supported

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

setBaseResourceAsString	back to summary
public void setBaseResourceAsString(String base) Parameters base:String 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	back to summary
public void setCacheControl(String cacheControl) Set the cacheControl header to set on all static content.. Parameters cacheControl:String the cacheControl header to set on all static content.

setCacheControl

back to summary

public void setCacheControl(String cacheControl)

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

Parameters

cacheControl:String: the cacheControl header to set on all static content.

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

setEncodingCacheSize	back to summary
public void setEncodingCacheSize(int encodingCacheSize)

setEtags	back to summary
public void setEtags(boolean etags) Parameters etags:boolean True if ETag processing is done

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

setGzipEquivalentFileExtensions

back to summary

public void setGzipEquivalentFileExtensions(List<String> gzipEquivalentFileExtensions)

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

Parameters

gzipEquivalentFileExtensions:List<String>: file extensions that signify that a file is gzip compressed. Eg ".svgz"

setMimeTypes	back to summary
public void setMimeTypes(MimeTypes mimeTypes)

setPrecompressedFormats	back to summary
public void setPrecompressedFormats(CompressedContentFormat... precompressedFormats) Parameters precompressedFormats:CompressedContentFormat[] 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	back to summary
public void setPrecompressedFormats(List<CompressedContentFormat> precompressedFormats) Parameters precompressedFormats:List<CompressedContentFormat> 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.

setStyleSheet	back to summary
public void setStyleSheet(Resource styleSheet) Parameters styleSheet:Resource The location of the style sheet to be used as a String.

setupWelcomeFactory	back to summary
protected ResourceService.WelcomeFactory setupWelcomeFactory()

setUseFileMapping	back to summary
public void setUseFileMapping(boolean useFileMapping)

setWelcomeFiles	back to summary
public void setWelcomeFiles(String... welcomeFiles)

setWelcomeFiles	back to summary
public void setWelcomeFiles(List<String> welcomeFiles)

setWelcomeMode	back to summary
public void setWelcomeMode(ResourceService.WelcomeMode welcomeMode)

org.eclipse.jetty.server.handler back to summary

private Class ResourceHandler.HandlerResourceService

Class Inheritance

extends ResourceService

java.lang.Object
org.eclipse.jetty.server.ResourceService
org.eclipse.jetty.server.handler.ResourceHandler.HandlerResourceService

Constructor Summary

Access	Constructor and Description
private	HandlerResourceService()

Method Summary

Modifier and Type	Method and Description
protected void	rehandleWelcome(Request the request request, Response the response response, Callback the callback to complete callback, String the welcome target to rehandle to welcomeTarget) Overrides org.eclipse.jetty.server.ResourceService.rehandleWelcome. Rehandles the given welcome target.

Constructor Detail

HandlerResourceService	back to summary
private HandlerResourceService()

Method Detail

rehandleWelcome back to summary

protected void rehandleWelcome(Request request, Response response, Callback callback, String welcomeTarget) throws Exception

Overrides org.eclipse.jetty.server.ResourceService.rehandleWelcome.

Doc from org.eclipse.jetty.server.ResourceService.rehandleWelcome.

Rehandles the given welcome target.

Implementations should call Handler#handle(Request, Response, Callback) on a Handler that may handle the welcome target differently from the original request.

For example, a request for /ctx/ may be rewritten as /ctx/index.jsp and rehandled from the Server. In this example, the rehandling of /ctx/index.jsp may trigger a different code path so that the rewritten request is handled by a different Handler, in this example one that knows how to handle JSP resources.

Parameters

request:Request: the request
response:Response: the response
callback:Callback: the callback to complete
welcomeTarget:String: the welcome target to rehandle to

Annotations

@Override

Exceptions

Exception:: if the rehandling fails

public Class ResourceHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ResourceHandler.HandlerResourceService

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class ResourceHandler.ResourceContext

Field Summary

Constructor Summary

Method Summary

Constructor Detail