org.apache.wiki.providers

Class CachingAttachmentProvider

java.lang.Object

org.apache.wiki.providers.CachingAttachmentProvider

All Implemented Interfaces:

AttachmentProvider, WikiProvider

public class CachingAttachmentProvider
extends Object
implements AttachmentProvider

Provides a caching attachment provider. This class rests on top of a real provider class and provides a cache to speed things up. Only the Attachment objects are cached; the actual attachment contents are fetched always from the provider.

Since:

2.1.64.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTCACHE_NAME Name of the attachment cache.
static String	ATTCOLLCACHE_NAME Name of the attachment cache.
static String	DIR_EXTENSION The extension to append to directory names to denote an attachment directory.
static int	m_capacity Default cache capacity for now.

Fields inherited from interface org.apache.wiki.api.providers.AttachmentProvider

PROP_STORAGEDIR

Fields inherited from interface org.apache.wiki.api.providers.WikiProvider

LATEST_VERSION

Constructor Summary

Constructors

Constructor and Description
CachingAttachmentProvider()

Method Summary

Modifier and Type	Method and Description
void	deleteAttachment(Attachment att)
void	deleteVersion(Attachment att)
Collection<Attachment>	findAttachments(QueryItem[] query)
InputStream	getAttachmentData(Attachment att)
Attachment	getAttachmentInfo(Page page, String name, int version)
String	getProviderInfo() Gets the provider class name, and cache statistics (misscount and,hitcount of the attachment cache).
AttachmentProvider	getRealProvider() Returns the WikiAttachmentProvider that this caching provider delegates to.
List<Attachment>	getVersionHistory(Attachment att)
void	initialize(Engine engine, Properties properties)
List<Attachment>	listAllChanged(Date timestamp)
List<Attachment>	listAttachments(Page page)
void	moveAttachmentsForPage(String oldParent, String newParent)
void	putAttachmentData(Attachment att, InputStream data)

Methods inherited from class java.lang.Object

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

Field Detail

m_capacity

public static final int m_capacity

Default cache capacity for now.

See Also:

Constant Field Values

ATTCACHE_NAME

public static final String ATTCACHE_NAME

Name of the attachment cache.

See Also:

Constant Field Values

ATTCOLLCACHE_NAME

public static final String ATTCOLLCACHE_NAME

Name of the attachment cache.

See Also:

Constant Field Values

DIR_EXTENSION

public static final String DIR_EXTENSION

The extension to append to directory names to denote an attachment directory.

See Also:

Constant Field Values

Constructor Detail

CachingAttachmentProvider

public CachingAttachmentProvider()

Method Detail

initialize

public void initialize(Engine engine,
                       Properties properties)
                throws NoRequiredPropertyException,
                       IOException

Specified by:

initialize in interface WikiProvider

Throws:

NoRequiredPropertyException

IOException

putAttachmentData

public void putAttachmentData(Attachment att,
                              InputStream data)
                       throws ProviderException,
                              IOException

Specified by:

putAttachmentData in interface AttachmentProvider

Throws:

ProviderException

IOException

getAttachmentData

public InputStream getAttachmentData(Attachment att)
                              throws ProviderException,
                                     IOException

Specified by:

getAttachmentData in interface AttachmentProvider

Throws:

ProviderException

IOException

listAttachments

public List<Attachment> listAttachments(Page page)
                                 throws ProviderException

Specified by:

listAttachments in interface AttachmentProvider

Throws:

ProviderException

findAttachments

public Collection<Attachment> findAttachments(QueryItem[] query)

Specified by:

findAttachments in interface AttachmentProvider

listAllChanged

public List<Attachment> listAllChanged(Date timestamp)
                                throws ProviderException

Specified by:

listAllChanged in interface AttachmentProvider

Throws:

ProviderException

getAttachmentInfo

public Attachment getAttachmentInfo(Page page,
                                    String name,
                                    int version)
                             throws ProviderException

Specified by:

getAttachmentInfo in interface AttachmentProvider

Throws:

ProviderException

getVersionHistory

public List<Attachment> getVersionHistory(Attachment att)

Specified by:

getVersionHistory in interface AttachmentProvider

deleteVersion

public void deleteVersion(Attachment att)
                   throws ProviderException

Specified by:

deleteVersion in interface AttachmentProvider

Throws:

ProviderException

deleteAttachment

public void deleteAttachment(Attachment att)
                      throws ProviderException

Specified by:

deleteAttachment in interface AttachmentProvider

Throws:

ProviderException

getProviderInfo

public String getProviderInfo()

Gets the provider class name, and cache statistics (misscount and,hitcount of the attachment cache).

Specified by:

getProviderInfo in interface WikiProvider

Returns:

A plain string with all the above mentioned values.

getRealProvider

public AttachmentProvider getRealProvider()

Returns the WikiAttachmentProvider that this caching provider delegates to.

Returns:

The real provider underneath this one.

moveAttachmentsForPage

public void moveAttachmentsForPage(String oldParent,
                                   String newParent)
                            throws ProviderException

Specified by:

moveAttachmentsForPage in interface AttachmentProvider

Throws:

ProviderException