Package org.apache.wiki.providers

Class BasicAttachmentProvider

java.lang.Object

org.apache.wiki.providers.BasicAttachmentProvider

All Implemented Interfaces:

org.apache.wiki.api.providers.AttachmentProvider, org.apache.wiki.api.providers.WikiProvider

public class BasicAttachmentProvider
extends Object
implements org.apache.wiki.api.providers.AttachmentProvider

Provides basic, versioning attachments.

   Structure is as follows:
      attachment_dir/
         ThisPage/
            attachment.doc/
               attachment.properties
               1.doc
               2.doc
               3.doc
            picture.png/
               attachment.properties
               1.png
               2.png
         ThatPage/
            picture.png/
               attachment.properties
               1.png
             
  

The names of the directories will be URLencoded.

"attachment.properties" consists of the following items:

• 1.author = author name for version 1 (etc)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicAttachmentProvider.AttachmentFilter	Returns only those directories that contain attachments.
static class	BasicAttachmentProvider.AttachmentVersionFilter	Accepts only files that are actual versions, no control files.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTDIR_EXTENSION	The default extension for the attachment directory.
static final String	DIR_EXTENSION	The default extension for the page attachment directory name.
static final String	PROP_DISABLECACHE	The property name for specifying which attachments are not cached.
static final String	PROPERTY_FILE	The name of the property file.

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	Description
BasicAttachmentProvider()

Method Summary

Modifier and Type	Method	Description
void	deleteAttachment(org.apache.wiki.api.core.Attachment att)
void	deleteVersion(org.apache.wiki.api.core.Attachment att)
Collection<org.apache.wiki.api.core.Attachment>	findAttachments(org.apache.wiki.api.search.QueryItem[] query)
InputStream	getAttachmentData(org.apache.wiki.api.core.Attachment att)
org.apache.wiki.api.core.Attachment	getAttachmentInfo(org.apache.wiki.api.core.Page page, String name, int version)
protected static String	getFileExtension(String filename)	Returns the file extension.
String	getProviderInfo()
List<org.apache.wiki.api.core.Attachment>	getVersionHistory(org.apache.wiki.api.core.Attachment att)
void	initialize(org.apache.wiki.api.core.Engine engine, Properties properties)
List<org.apache.wiki.api.core.Attachment>	listAllChanged(Date timestamp)
List<org.apache.wiki.api.core.Attachment>	listAttachments(org.apache.wiki.api.core.Page page)
void	moveAttachmentsForPage(String oldParent, String newParent)
void	putAttachmentData(org.apache.wiki.api.core.Attachment att, InputStream data)

Methods inherited from class java.lang.Object

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

Field Details

PROP_DISABLECACHE

public static final String PROP_DISABLECACHE

The property name for specifying which attachments are not cached. Value is "jspwiki.basicAttachmentProvider.disableCache".

See Also:

• Constant Field Values

PROPERTY_FILE

public static final String PROPERTY_FILE

The name of the property file.

See Also:

• Constant Field Values

DIR_EXTENSION

public static final String DIR_EXTENSION

The default extension for the page attachment directory name.

See Also:

• Constant Field Values

ATTDIR_EXTENSION

public static final String ATTDIR_EXTENSION

The default extension for the attachment directory.

See Also:

• Constant Field Values

Constructor Details

BasicAttachmentProvider

public BasicAttachmentProvider()

Method Details

initialize

public void initialize(org.apache.wiki.api.core.Engine engine,
 Properties properties)
                throws org.apache.wiki.api.exceptions.NoRequiredPropertyException,
IOException

Specified by:

initialize in interface org.apache.wiki.api.providers.WikiProvider

Throws:

org.apache.wiki.api.exceptions.NoRequiredPropertyException

IOException

getFileExtension

protected static String getFileExtension(String filename)

Returns the file extension. For example "test.png" returns "png".

If file has no extension, will return "bin"

Parameters:

filename - The file name to check

Returns:

The extension. If no extension is found, returns "bin".

putAttachmentData

public void putAttachmentData(org.apache.wiki.api.core.Attachment att,
 InputStream data)
                       throws org.apache.wiki.api.exceptions.ProviderException,
IOException

Specified by:

putAttachmentData in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

IOException

getProviderInfo

public String getProviderInfo()

Specified by:

getProviderInfo in interface org.apache.wiki.api.providers.WikiProvider

getAttachmentData

public InputStream getAttachmentData(org.apache.wiki.api.core.Attachment att)
                              throws IOException,
org.apache.wiki.api.exceptions.ProviderException

Specified by:

getAttachmentData in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

IOException

org.apache.wiki.api.exceptions.ProviderException

listAttachments

public List<org.apache.wiki.api.core.Attachment> listAttachments(org.apache.wiki.api.core.Page page)
                                                          throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

listAttachments in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

findAttachments

public Collection<org.apache.wiki.api.core.Attachment> findAttachments(org.apache.wiki.api.search.QueryItem[] query)

Specified by:

findAttachments in interface org.apache.wiki.api.providers.AttachmentProvider

listAllChanged

public List<org.apache.wiki.api.core.Attachment> listAllChanged(Date timestamp)
                                                         throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

listAllChanged in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

getAttachmentInfo

public org.apache.wiki.api.core.Attachment getAttachmentInfo(org.apache.wiki.api.core.Page page,
 String name,
 int version)
                                                      throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

getAttachmentInfo in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

getVersionHistory

public List<org.apache.wiki.api.core.Attachment> getVersionHistory(org.apache.wiki.api.core.Attachment att)

Specified by:

getVersionHistory in interface org.apache.wiki.api.providers.AttachmentProvider

deleteVersion

public void deleteVersion(org.apache.wiki.api.core.Attachment att)
                   throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

deleteVersion in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

deleteAttachment

public void deleteAttachment(org.apache.wiki.api.core.Attachment att)
                      throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

deleteAttachment in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException

moveAttachmentsForPage

public void moveAttachmentsForPage(String oldParent,
 String newParent)
                            throws org.apache.wiki.api.exceptions.ProviderException

Specified by:

moveAttachmentsForPage in interface org.apache.wiki.api.providers.AttachmentProvider

Throws:

org.apache.wiki.api.exceptions.ProviderException