Top Description Inners Fields Constructors Methods

org.eclipse.jetty.http.content

public Class ValidatingCachingHttpContentFactory

Class Inheritance

extends CachingHttpContentFactory
implements Runnable

java.lang.Object
org.eclipse.jetty.http.content.CachingHttpContentFactory
org.eclipse.jetty.http.content.ValidatingCachingHttpContentFactory

All Implemented Interfaces

java.lang.Runnable

Imports

java.util.Map, .Objects, java.util.concurrent.ConcurrentMap, .TimeUnit, java.util.concurrent.atomic.AtomicLong, org.eclipse.jetty.io.ByteBufferPool, org.eclipse.jetty.util.NanoTime, org.eclipse.jetty.util.annotation.Name, org.eclipse.jetty.util.thread.Scheduler

HttpContent.Factory implementation of CachingHttpContentFactory which evicts invalid entries from the cache. Uses a validationTime parameter to check files when they are accessed and/or sweepDelay parameter for a periodic sweep for invalid entries in the cache.

HttpContent validation checks are configured through the validationTime parameter in the constructor. If an HttpContent is found to be invalid it will be removed from the cache. A value of -1 means that the cached HttpContent will never be checked if it is still valid, a value of 0 means it is checked on every request, a positive value indicates the number of milliseconds of the minimum time between validation checks.

This also remember a missed entry for the time set by validationTimems. After this has elapsed the entry will be invalid and will be evicted from the cache at the next access.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	ValidatingCachingHttpContentFactory.ValidatingCachedContent
protected static class	ValidatingCachingHttpContentFactory.ValidatingNotFoundContent

Field Summary

Modifier and Type	Field and Description
private final long	_maxCacheIdleTime
private final Scheduler	_scheduler
private final long	_sweepDelay
private final long	_validationTime

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	ValidatingCachingHttpContentFactory(HttpContent.Factory the wrapped `HttpContent.Factory` to use. authority, long time between filesystem checks in ms to see if an `HttpContent` is still valid (-1 never validate, 0 always validate). validationPeriod, ByteBufferPool the `org.eclipse.jetty.io.ByteBufferPool` to use. bufferPool) Construct a `ValidatingCachingHttpContentFactory` which validates entries upon use to check if they are still valid.
public	ValidatingCachingHttpContentFactory(HttpContent.Factory the wrapped `HttpContent.Factory` to use. authority, long time between filesystem checks in ms to see if an `HttpContent` is still valid (-1 never validate, 0 always validate). validationPeriod, ByteBufferPool the `org.eclipse.jetty.io.ByteBufferPool` to use. bufferPool, Scheduler scheduler to use for the sweeper, can be null to not use sweeper. scheduler, long time between runs of the sweeper in ms (if 0 never sweep for invalid entries). sweepPeriod, long amount of time in ms an entry can be unused before evicted by the sweeper (if 0 never evict unused entries). idleTimeout) Construct a `ValidatingCachingHttpContentFactory` which validates entries upon use to check if they are still valid and an optional period sweeper of the cache to find invalid and old entries to evict.

public

ValidatingCachingHttpContentFactory(HttpContent.Factory

the wrapped HttpContent.Factory to use.

authority, long

time between filesystem checks in ms to see if an HttpContent is still valid (-1 never validate, 0 always validate).

validationPeriod, ByteBufferPool

the org.eclipse.jetty.io.ByteBufferPool to use.

bufferPool)

Construct a ValidatingCachingHttpContentFactory which validates entries upon use to check if they are still valid.

public

ValidatingCachingHttpContentFactory(HttpContent.Factory

the wrapped HttpContent.Factory to use.

authority, long

time between filesystem checks in ms to see if an HttpContent is still valid (-1 never validate, 0 always validate).

validationPeriod, ByteBufferPool

the org.eclipse.jetty.io.ByteBufferPool to use.

bufferPool, Scheduler

scheduler to use for the sweeper, can be null to not use sweeper.

scheduler, long

time between runs of the sweeper in ms (if 0 never sweep for invalid entries).

sweepPeriod, long

amount of time in ms an entry can be unused before evicted by the sweeper (if 0 never evict unused entries).

idleTimeout)

Construct a ValidatingCachingHttpContentFactory which validates entries upon use to check if they are still valid and an optional period sweeper of the cache to find invalid and old entries to evict.

Method Summary

Modifier and Type	Method and Description
protected boolean	isCacheable(HttpContent the HttpContent to test. httpContent) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.isCacheable. 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) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newCachedContent.
protected CachingHttpContentFactory.CachingHttpContent	newNotFoundContent(String p) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newNotFoundContent.
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	schedule()

Inherited from org.eclipse.jetty.http.content.CachingHttpContentFactory:: flushCache getCache getCachedFiles getCachedSize getContent getMaxCachedFiles getMaxCachedFileSize getMaxCacheSize isUseDirectByteBuffers removeFromCache setMaxCachedFiles setMaxCachedFileSize setMaxCacheSize setUseDirectByteBuffers

Field Detail

_maxCacheIdleTime	back to summary
private final long _maxCacheIdleTime

_scheduler	back to summary
private final Scheduler _scheduler

_sweepDelay	back to summary
private final long _sweepDelay

_validationTime	back to summary
private final long _validationTime

Constructor Detail

ValidatingCachingHttpContentFactory back to summary

ValidatingCachingHttpContentFactory	back to summary
public ValidatingCachingHttpContentFactory(HttpContent.Factory authority, long validationPeriod, ByteBufferPool bufferPool) Construct a `ValidatingCachingHttpContentFactory` which validates entries upon use to check if they are still valid. Parameters authority:HttpContent.Factory the wrapped `HttpContent.Factory` to use. validationPeriod:long time between filesystem checks in ms to see if an `HttpContent` is still valid (-1 never validate, 0 always validate). bufferPool:ByteBufferPool the `org.eclipse.jetty.io.ByteBufferPool` to use.

public ValidatingCachingHttpContentFactory(HttpContent.Factory authority, long validationPeriod, ByteBufferPool bufferPool)

Construct a ValidatingCachingHttpContentFactory which validates entries upon use to check if they are still valid.

Parameters

authority:HttpContent.Factory: the wrapped HttpContent.Factory to use.
validationPeriod:long: time between filesystem checks in ms to see if an HttpContent is still valid (-1 never validate, 0 always validate).
bufferPool:ByteBufferPool: the org.eclipse.jetty.io.ByteBufferPool to use.

ValidatingCachingHttpContentFactory back to summary

ValidatingCachingHttpContentFactory	back to summary
public ValidatingCachingHttpContentFactory(HttpContent.Factory authority, long validationPeriod, ByteBufferPool bufferPool, Scheduler scheduler, long sweepPeriod, long idleTimeout) Construct a `ValidatingCachingHttpContentFactory` which validates entries upon use to check if they are still valid and an optional period sweeper of the cache to find invalid and old entries to evict. Parameters authority:HttpContent.Factory the wrapped `HttpContent.Factory` to use. validationPeriod:long time between filesystem checks in ms to see if an `HttpContent` is still valid (-1 never validate, 0 always validate). bufferPool:ByteBufferPool the `org.eclipse.jetty.io.ByteBufferPool` to use. scheduler:Scheduler scheduler to use for the sweeper, can be null to not use sweeper. sweepPeriod:long time between runs of the sweeper in ms (if 0 never sweep for invalid entries). idleTimeout:long amount of time in ms an entry can be unused before evicted by the sweeper (if 0 never evict unused entries).

public ValidatingCachingHttpContentFactory(HttpContent.Factory authority, long validationPeriod, ByteBufferPool bufferPool, Scheduler scheduler, long sweepPeriod, long idleTimeout)

Parameters

authority:HttpContent.Factory: the wrapped HttpContent.Factory to use.
validationPeriod:long: time between filesystem checks in ms to see if an HttpContent is still valid (-1 never validate, 0 always validate).
bufferPool:ByteBufferPool: the org.eclipse.jetty.io.ByteBufferPool to use.
scheduler:Scheduler: scheduler to use for the sweeper, can be null to not use sweeper.
sweepPeriod:long: time between runs of the sweeper in ms (if 0 never sweep for invalid entries).
idleTimeout:long: amount of time in ms an entry can be unused before evicted by the sweeper (if 0 never evict unused entries).

Method Detail

isCacheable	back to summary
protected boolean isCacheable(HttpContent httpContent) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.isCacheable. Doc from org.eclipse.jetty.http.content.CachingHttpContentFactory.isCacheable. Tests whether the given HttpContent is cacheable, and if there is enough room to fit it in the cache. Parameters httpContent:HttpContent the HttpContent to test. Returns:boolean whether the HttpContent is cacheable. Annotations @Override

isCacheable

back to summary

protected boolean isCacheable(HttpContent httpContent)

Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.isCacheable.

Doc from org.eclipse.jetty.http.content.CachingHttpContentFactory.isCacheable.

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

Parameters

httpContent:HttpContent: the HttpContent to test.

Returns:boolean

whether the HttpContent is cacheable.

Annotations

@Override

newCachedContent	back to summary
protected CachingHttpContentFactory.CachingHttpContent newCachedContent(String p, HttpContent httpContent) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newCachedContent. Annotations @Override

newCachedContent

back to summary

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

Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newCachedContent.

Annotations

@Override

newNotFoundContent	back to summary
protected CachingHttpContentFactory.CachingHttpContent newNotFoundContent(String p) Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newNotFoundContent. Annotations @Override

newNotFoundContent

back to summary

protected CachingHttpContentFactory.CachingHttpContent newNotFoundContent(String p)

Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.newNotFoundContent.

Annotations

@Override

run	back to summary
public void run() Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

schedule	back to summary
private void schedule()

org.eclipse.jetty.http.content back to summary

protected Class ValidatingCachingHttpContentFactory.ValidatingCachedContent

Class Inheritance

extends CachedHttpContent

java.lang.Object
org.eclipse.jetty.http.content.HttpContent.Wrapper
org.eclipse.jetty.http.content.CachingHttpContentFactory.CachedHttpContent
org.eclipse.jetty.http.content.ValidatingCachingHttpContentFactory.ValidatingCachedContent

Field Summary

Modifier and Type	Field and Description
private final AtomicLong	_lastValidated
private final long	_validationTime

Constructor Summary

Access	Constructor and Description
public	ValidatingCachedContent(String key, HttpContent httpContent, long validationTime)

Method Summary

Modifier and Type	Method and Description
public boolean	isValid() Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.CachedHttpContent.isValid. Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid.

Inherited from org.eclipse.jetty.http.content.CachingHttpContentFactory.CachedHttpContent:: getByteBuffer getBytesOccupied getCharacterEncoding getContentLength getContentLengthValue getETag getETagValue getKey getLastAccessedNanos getLastModified getLastModifiedInstant getLastModifiedValue getMimeType getPreCompressedContentFormats release retain setLastAccessedNanos

Field Detail

_lastValidated	back to summary
private final AtomicLong _lastValidated

_validationTime	back to summary
private final long _validationTime

Constructor Detail

ValidatingCachedContent	back to summary
public ValidatingCachedContent(String key, HttpContent httpContent, long validationTime)

Method Detail

isValid	back to summary
public boolean isValid() Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.CachedHttpContent.isValid. Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid. Annotations @Override

isValid

back to summary

public boolean isValid()

Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.CachedHttpContent.isValid.

Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid.

Annotations

@Override

org.eclipse.jetty.http.content back to summary

protected Class ValidatingCachingHttpContentFactory.ValidatingNotFoundContent

Class Inheritance

extends NotFoundHttpContent

java.lang.Object
org.eclipse.jetty.http.content.CachingHttpContentFactory.NotFoundHttpContent
org.eclipse.jetty.http.content.ValidatingCachingHttpContentFactory.ValidatingNotFoundContent

Field Summary

Modifier and Type	Field and Description
private final AtomicLong	_lastValidated
private final long	_validationTime

Constructor Summary

Access	Constructor and Description
public	ValidatingNotFoundContent(String key, long validationTime)

Method Summary

Modifier and Type	Method and Description
public boolean	isValid() Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.NotFoundHttpContent.isValid. Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid.

Field Detail

_lastValidated	back to summary
private final AtomicLong _lastValidated

_validationTime	back to summary
private final long _validationTime

Constructor Detail

ValidatingNotFoundContent	back to summary
public ValidatingNotFoundContent(String key, long validationTime)

Method Detail

isValid	back to summary
public boolean isValid() Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.NotFoundHttpContent.isValid. Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid. Annotations @Override

isValid

back to summary

public boolean isValid()

Overrides org.eclipse.jetty.http.content.CachingHttpContentFactory.NotFoundHttpContent.isValid.

Implements org.eclipse.jetty.http.content.CachingHttpContentFactory.CachingHttpContent.isValid.

Annotations

@Override