Class CachingHttpContentFactory

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.http.content.CachingHttpContentFactory

All Implemented Interfaces:

HttpContent.Factory, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

ValidatingCachingHttpContentFactory

@ManagedObject
public class CachingHttpContentFactory
extends ContainerLifeCycle
implements HttpContent.Factory

HttpContent.Factory implementation that wraps any other HttpContent.Factory instance using it as a caching authority. Only HttpContent instances whose path is not a directory are cached.

No eviction is done by this HttpContent.Factory, once an entry is in the cache it is always assumed to be valid. This class can be extended to implement the validation behaviors on CachingHttpContentFactory.CachingHttpContent which allow entries to be evicted once they become invalid.

The default values for the cache are:

• maxCachedFileSize: 268435456L
• maxCachedFiles: 2048
• maxCacheSize: 268435456L

See Also:

• ValidatingCachingHttpContentFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	CachingHttpContentFactory.CachedHttpContent
protected static interface	CachingHttpContentFactory.CachingHttpContent
protected static class	CachingHttpContentFactory.NotFoundHttpContent

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer, Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

LEGEND

Constructor Summary

Constructors

Constructor	Description
CachingHttpContentFactory(HttpContent.Factory authority, ByteBufferPool.Sized bufferPool)

Method Summary

Modifier and Type	Method	Description
void	flushCache()
protected ConcurrentMap<String, CachingHttpContentFactory.CachingHttpContent>	getCache()
int	getCachedFiles()
long	getCachedSize()
HttpContent	getContent(String path)	Get the HttpContent instance of a path.
int	getMaxCachedFiles()	Get the max number of cached files.
int	getMaxCachedFileSize()
long	getMaxCacheSize()
protected boolean	isCacheable(HttpContent httpContent)	Tests whether the given HttpContent is cacheable, and if there is enough room to fit it in the cache.
protected CachingHttpContentFactory.CachingHttpContent	newCachedContent(String p, HttpContent httpContent)
protected CachingHttpContentFactory.CachingHttpContent	newNotFoundContent(String p)
protected void	removeFromCache(CachingHttpContentFactory.CachingHttpContent content)
void	setMaxCachedFiles(int maxCachedFiles)	Set the max number of cached files.
void	setMaxCachedFileSize(int maxCachedFileSize)
void	setMaxCacheSize(long maxCacheSize)

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, addManaged, contains, destroy, doStart, doStop, 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 AbstractLifeCycle

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

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Constructor Details

CachingHttpContentFactory

public CachingHttpContentFactory(HttpContent.Factory authority,
 ByteBufferPool.Sized bufferPool)

Method Details

getCache

protected ConcurrentMap<String, CachingHttpContentFactory.CachingHttpContent> getCache()

getCachedSize

@ManagedAttribute(value="Current total size in bytes of cached content",
                  readonly=true)
public long getCachedSize()

getCachedFiles

@ManagedAttribute(value="Current number of cached files",
                  readonly=true)
public int getCachedFiles()

getMaxCachedFileSize

@ManagedAttribute("Maximum size in bytes for a file to be eligible for caching")
public int getMaxCachedFileSize()

setMaxCachedFileSize

public void setMaxCachedFileSize(int maxCachedFileSize)

getMaxCacheSize

@ManagedAttribute("Maximum total size in bytes allowed for the cache")
public long getMaxCacheSize()

setMaxCacheSize

public void setMaxCacheSize(long maxCacheSize)

getMaxCachedFiles

@ManagedAttribute("Maximum number of entries allowed in the cache")
public int getMaxCachedFiles()

Get the max number of cached files.

Returns:

the max number of cached files.

setMaxCachedFiles

public void setMaxCachedFiles(int maxCachedFiles)

Set the max number of cached files.

Parameters:

maxCachedFiles - the max number of cached files.

removeFromCache

protected void removeFromCache(CachingHttpContentFactory.CachingHttpContent content)

flushCache

public void flushCache()

isCacheable

protected boolean isCacheable(HttpContent httpContent)

Tests whether the given HttpContent is cacheable, and if there is enough room to fit it in the cache.

Parameters:

httpContent - the HttpContent to test.

Returns:

whether the HttpContent is cacheable.

getContent

public HttpContent getContent(String path)
                       throws IOException

Description copied from interface: HttpContent.Factory

Get the HttpContent instance of a path.

Specified by:

getContent in interface HttpContent.Factory

Parameters:

path - The path.

Returns:

A HttpContent instance.

Throws:

IOException - if unable to get content

newCachedContent

protected CachingHttpContentFactory.CachingHttpContent newCachedContent(String p,
 HttpContent httpContent)

newNotFoundContent

protected CachingHttpContentFactory.CachingHttpContent newNotFoundContent(String p)