Package org.opencms.loader

Class CmsRfsImageCache

java.lang.Object

org.opencms.loader.CmsRfsImageCache

All Implemented Interfaces:

AutoCloseable, I_CmsImageCache

Direct Known Subclasses:

CmsFsImageCache

public class CmsRfsImageCache
extends Object
implements I_CmsImageCache

RFS 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
CmsRfsImageCache(String repository)	Creates a new RFS image cache.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clears all image cache entries.
boolean	exists(String key)	Returns if the image cache entry exists.
long	getLength(String key)	Returns the image cache entry length.
protected Path	getRepository()	Returns the image cache repository.
String	getRepositoryPath()	Returns the absolute repository path.
protected void	initRepository(Path repository)	Initializes the image cache repository.
boolean	supportsRangeDelivery()	Returns if range delivery is supported.
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 java.lang.Object

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

Methods inherited from interface org.opencms.loader.I_CmsImageCache

close, existsAuthoritatively, visitEntries

Constructor Details

CmsRfsImageCache

public CmsRfsImageCache(String repository)
                 throws Exception

Creates a new RFS image cache.

Parameters:

repository - the image cache repository path

Throws:

Exception - if the repository 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

Throws:

Exception - if clearing fails

See Also:

• I_CmsImageCache.clear()

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

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

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)

getRepositoryPath

public String getRepositoryPath()

Returns the absolute repository path.

Returns:

the repository path

supportsRangeDelivery

public boolean supportsRangeDelivery()

Description copied from interface: I_CmsImageCache

Returns if range delivery is supported.

Specified by:

supportsRangeDelivery in interface I_CmsImageCache

Returns:

true if ranges can be streamed

See Also:

• I_CmsImageCache.supportsRangeDelivery()

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

Parameters:

visitor - the image cache entry visitor

Throws:

Exception - if listing fails

See Also:

• I_CmsImageCache.visitEntries(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

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

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

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)

getRepository

protected Path getRepository()

Returns the image cache repository.

Returns:

the repository

initRepository

protected void initRepository(Path repository)
                       throws Exception

Initializes the image cache repository.

Parameters:

repository - the image cache repository

Throws:

Exception - if the repository can not be initialized