Package org.opencms.loader

Class CmsFsImageCache

java.lang.Object

org.opencms.loader.CmsRfsImageCache

org.opencms.loader.CmsFsImageCache

All Implemented Interfaces:

AutoCloseable, I_CmsImageCache

public class CmsFsImageCache
extends CmsRfsImageCache

File system based storage for generated image cache entries.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.loader.I_CmsImageCache

I_CmsImageCache.I_CmsImageCacheEntryVisitor

Constructor Summary

Constructors

Constructor	Description
CmsFsImageCache(String path)	Creates a new FS image cache.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all image cache entries.
void	close()	Closes the image cache and releases associated resources.
boolean	exists(String key)	Returns if the image cache entry exists.
long	getLength(String key)	Returns the image cache entry length.
protected Path	getPath(String key)	Returns the cache path for a key.
void	invalidateLocalMetadata(String key)	Invalidates locally cached metadata for an image cache entry.
void	visitEntries(String prefix, I_CmsImageCache.I_CmsImageCacheEntryVisitor visitor)	Visits image cache entries whose normalized keys start with the given prefix.
void	visitEntries(I_CmsImageCache.I_CmsImageCacheEntryVisitor visitor)	Visits all image cache entries.
void	write(String key, byte[] content)	Writes an image cache entry.
void	writeRangeTo(String key, long start, long length, OutputStream out)	Writes an image cache entry byte range to the output stream.
void	writeTo(String key, OutputStream out)	Writes an image cache entry to the output stream.

Methods inherited from class org.opencms.loader.CmsRfsImageCache

getRepository, getRepositoryPath, initRepository, supportsRangeDelivery

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencms.loader.I_CmsImageCache

existsAuthoritatively

Constructor Details

CmsFsImageCache

public CmsFsImageCache(String path)
                throws Exception

Creates a new FS image cache.

Parameters:

path - the file system path

Throws:

Exception - if the path can not be initialized

Method Details

clear

public void clear()
           throws Exception

Description copied from interface: I_CmsImageCache

Clears all image cache entries.

Specified by:

clear in interface I_CmsImageCache

Overrides:

clear in class CmsRfsImageCache

Throws:

Exception - if clearing fails

See Also:

• I_CmsImageCache.clear()

close

public void close()
           throws Exception

Description copied from interface: I_CmsImageCache

Closes the image cache and releases associated resources.

Throws:

Exception - if closing fails

See Also:

• I_CmsImageCache.close()

exists

public boolean exists(String key)
               throws Exception

Description copied from interface: I_CmsImageCache

Returns if the image cache entry exists.

Specified by:

exists in interface I_CmsImageCache

Overrides:

exists in class CmsRfsImageCache

Parameters:

key - the image cache key

Returns:

true if the image cache entry exists

Throws:

Exception - if the store access fails

See Also:

• I_CmsImageCache.exists(java.lang.String)

getLength

public long getLength(String key)
               throws Exception

Description copied from interface: I_CmsImageCache

Returns the image cache entry length.

Specified by:

getLength in interface I_CmsImageCache

Overrides:

getLength in class CmsRfsImageCache

Parameters:

key - the image cache key

Returns:

the image cache entry length

Throws:

Exception - if the store access fails

See Also:

• I_CmsImageCache.getLength(java.lang.String)

invalidateLocalMetadata

public void invalidateLocalMetadata(String key)

Invalidates locally cached metadata for an image cache entry.

This is used after maintenance operations which modify the shared file system outside the regular cache access path.

Parameters:

key - the image cache key

visitEntries

public void visitEntries(I_CmsImageCache.I_CmsImageCacheEntryVisitor visitor)
                  throws Exception

Description copied from interface: I_CmsImageCache

Visits all image cache entries.

Specified by:

visitEntries in interface I_CmsImageCache

Overrides:

visitEntries in class CmsRfsImageCache

Parameters:

visitor - the image cache entry visitor

Throws:

Exception - if listing fails

See Also:

• I_CmsImageCache.visitEntries(org.opencms.loader.I_CmsImageCache.I_CmsImageCacheEntryVisitor)

visitEntries

public void visitEntries(String prefix,
 I_CmsImageCache.I_CmsImageCacheEntryVisitor visitor)
                  throws Exception

Description copied from interface: I_CmsImageCache

Visits image cache entries whose normalized keys start with the given prefix.

Implementations with a prefix-aware storage backend should override this method to apply the prefix while listing. The default implementation filters the result of I_CmsImageCache.visitEntries(I_CmsImageCacheEntryVisitor).

Parameters:

prefix - the image cache key prefix, or an empty string for all entries

visitor - the image cache entry visitor

Throws:

Exception - if listing fails

See Also:

• I_CmsImageCache.visitEntries(java.lang.String, org.opencms.loader.I_CmsImageCache.I_CmsImageCacheEntryVisitor)

write

public void write(String key,
 byte[] content)
           throws Exception

Description copied from interface: I_CmsImageCache

Writes an image cache entry.

Specified by:

write in interface I_CmsImageCache

Overrides:

write in class CmsRfsImageCache

Parameters:

key - the image cache key

content - the image cache content

Throws:

Exception - if writing fails

See Also:

• I_CmsImageCache.write(java.lang.String, byte[])

writeRangeTo

public void writeRangeTo(String key,
 long start,
 long length,
 OutputStream out)
                  throws Exception

Description copied from interface: I_CmsImageCache

Writes an image cache entry byte range to the output stream.

Specified by:

writeRangeTo in interface I_CmsImageCache

Overrides:

writeRangeTo in class CmsRfsImageCache

Parameters:

key - the image cache key

start - the first byte to write

length - the number of bytes to write

out - the output stream

Throws:

Exception - if reading fails

See Also:

• I_CmsImageCache.writeRangeTo(java.lang.String, long, long, java.io.OutputStream)

writeTo

public void writeTo(String key,
 OutputStream out)
             throws Exception

Description copied from interface: I_CmsImageCache

Writes an image cache entry to the output stream.

Specified by:

writeTo in interface I_CmsImageCache

Overrides:

writeTo in class CmsRfsImageCache

Parameters:

key - the image cache key

out - the output stream

Throws:

Exception - if reading fails

See Also:

• I_CmsImageCache.writeTo(java.lang.String, java.io.OutputStream)

getPath

protected Path getPath(String key)

Returns the cache path for a key.

Parameters:

key - the image cache key

Returns:

the cache path