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 public class ResourceHandler extends HandlerWrapper implements ResourceFactory, ResourceService.WelcomeFactory
Deprecated.This api is not supported anymore. Please do not use it.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.server.handler.AbstractHandler
AbstractHandler.ErrorDispatchHandler
-
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
AbstractLifeCycle.AbstractLifeCycleListener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container
Container.InheritedListener, Container.Listener
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable
Dumpable.DumpableContainer
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
-
Constructor Summary
Constructors Constructor Description ResourceHandler()Deprecated.ResourceHandler(ResourceService resourceService)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voiddoStart()Deprecated.ResourcegetBaseResource()Deprecated.java.lang.StringgetCacheControl()Deprecated.static ResourcegetDefaultStylesheet()Deprecated.java.util.List<java.lang.String>getGzipEquivalentFileExtensions()Deprecated.MimeTypesgetMimeTypes()Deprecated.intgetMinAsyncContentLength()Deprecated.intgetMinMemoryMappedContentLength()Deprecated.CompressedContentFormat[]getPrecompressedFormats()Deprecated.ResourcegetResource(java.lang.String path)Deprecated.Get a resource for a path.java.lang.StringgetResourceBase()Deprecated.ResourcegetStylesheet()Deprecated.java.lang.StringgetWelcomeFile(java.lang.String pathInContext)Deprecated.Finds a matching welcome file for the suppliedResource.java.lang.String[]getWelcomeFiles()Deprecated.voidhandle(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)Deprecated.Handle a request.booleanisAcceptRanges()Deprecated.booleanisDirAllowed()Deprecated.booleanisDirectoriesListed()Deprecated.Get the directory option.booleanisEtags()Deprecated.booleanisGzip()Deprecated.booleanisPathInfoOnly()Deprecated.booleanisRedirectWelcome()Deprecated.voidsetAcceptRanges(boolean acceptRanges)Deprecated.voidsetBaseResource(Resource base)Deprecated.voidsetCacheControl(java.lang.String cacheControl)Deprecated.voidsetDirAllowed(boolean dirAllowed)Deprecated.voidsetDirectoriesListed(boolean directory)Deprecated.Set the directory.voidsetEtags(boolean etags)Deprecated.voidsetGzip(boolean gzip)Deprecated.voidsetGzipEquivalentFileExtensions(java.util.List<java.lang.String> gzipEquivalentFileExtensions)Deprecated.voidsetMimeTypes(MimeTypes mimeTypes)Deprecated.voidsetMinAsyncContentLength(int minAsyncContentLength)Deprecated.voidsetMinMemoryMappedContentLength(int minMemoryMappedFileSize)Deprecated.voidsetPathInfoOnly(boolean pathInfoOnly)Deprecated.voidsetPrecompressedFormats(CompressedContentFormat[] precompressedFormats)Deprecated.voidsetRedirectWelcome(boolean redirectWelcome)Deprecated.voidsetResourceBase(java.lang.String resourceBase)Deprecated.voidsetStylesheet(java.lang.String stylesheet)Deprecated.voidsetWelcomeFiles(java.lang.String[] welcomeFiles)Deprecated.-
Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper
destroy, getHandler, getHandlers, insertHandler, setHandler
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer
findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler
getServer
-
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
-
-
-
Constructor Detail
-
ResourceHandler
public ResourceHandler(ResourceService resourceService)
Deprecated.
-
ResourceHandler
public ResourceHandler()
Deprecated.
-
-
Method Detail
-
getWelcomeFile
public java.lang.String getWelcomeFile(java.lang.String pathInContext)
Deprecated.Description copied from interface:ResourceService.WelcomeFactoryFinds a matching welcome file for the suppliedResource.- Specified by:
getWelcomeFilein interfaceResourceService.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 java.lang.ExceptionDeprecated.- Throws:
java.lang.Exception
-
getBaseResource
public Resource getBaseResource()
Deprecated.- Returns:
- Returns the resourceBase.
-
getCacheControl
public java.lang.String getCacheControl()
Deprecated.- Returns:
- the cacheControl header to set on all static content.
-
getGzipEquivalentFileExtensions
public java.util.List<java.lang.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(java.lang.String path)
Deprecated.Description copied from interface:ResourceFactoryGet a resource for a path.- Specified by:
getResourcein interfaceResourceFactory- Parameters:
path- The path to the resource- Returns:
- The resource or null
-
getResourceBase
public java.lang.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 java.lang.String[] getWelcomeFiles()
Deprecated.
-
handle
public void handle(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response) throws java.io.IOException, ServletExceptionDeprecated.Description copied from interface:HandlerHandle a request.- Specified by:
handlein interfaceHandler- Overrides:
handlein classHandlerWrapper- Parameters:
target- The target of the request - either a URI or a name.baseRequest- The original unwrapped request object.request- The request either as theRequestobject or a wrapper of that request. Themethod can be used access the Request object if required.HttpConnection.getCurrentConnection().getHttpChannel().getRequest()response- The response as theResponseobject or a wrapper of that request. Themethod can be used access the Response object if required.HttpConnection.getCurrentConnection().getHttpChannel().getResponse()- Throws:
java.io.IOException- if unable to handle the request or response processingServletException- 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(java.lang.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(java.util.List<java.lang.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 usingServletResponse.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(java.lang.String resourceBase)
Deprecated.- Parameters:
resourceBase- The base resource as a string.
-
setStylesheet
public void setStylesheet(java.lang.String stylesheet)
Deprecated.- Parameters:
stylesheet- The location of the stylesheet to be used as a String.
-
setWelcomeFiles
public void setWelcomeFiles(java.lang.String[] welcomeFiles)
Deprecated.
-
-