com.ecyrd.jspwiki.providers
Class BasicAttachmentProvider

java.lang.Object
  |
  +--com.ecyrd.jspwiki.providers.BasicAttachmentProvider

All Implemented Interfaces:

WikiAttachmentProvider, WikiProvider

public class BasicAttachmentProvider

extends java.lang.Object

implements WikiAttachmentProvider

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

class	BasicAttachmentProvider.AttachmentFilter Returns only those directories that contain attachments.
class	BasicAttachmentProvider.AttachmentVersionFilter Accepts only files that are actual versions, no control files.

Field Summary

static java.lang.String	ATTDIR_EXTENSION
static java.lang.String	DIR_EXTENSION
static java.lang.String	PROP_STORAGEDIR
static java.lang.String	PROPERTY_FILE

Fields inherited from interface com.ecyrd.jspwiki.WikiProvider

LATEST_VERSION

Constructor Summary

BasicAttachmentProvider()

Method Summary

void	deleteAttachment(Attachment att) Removes an entire page from the repository.
void	deleteVersion(Attachment att) Removes a specific version from the repository.
java.util.Collection	findAttachments(QueryItem[] query) Finds attachments based on the query.
java.io.InputStream	getAttachmentData(Attachment att) Get attachment data.
Attachment	getAttachmentInfo(WikiPage page, java.lang.String name, int version) Returns info about an attachment.
protected static java.lang.String	getFileExtension(java.lang.String filename) Returns the file extension.
java.lang.String	getProviderInfo() Return a valid HTML string for information.
java.util.List	getVersionHistory(Attachment att) Returns version history.
void	initialize(java.util.Properties properties) Initializes the page provider.
java.util.List	listAllChanged(java.util.Date timestamp) Lists changed attachments since given date.
java.util.Collection	listAttachments(WikiPage page) Lists all attachments attached to a page.
void	putAttachmentData(Attachment att, java.io.InputStream data) Put new attachment data.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_STORAGEDIR

public static final java.lang.String PROP_STORAGEDIR

See Also:

Constant Field Values

PROPERTY_FILE

public static final java.lang.String PROPERTY_FILE

See Also:

Constant Field Values

DIR_EXTENSION

public static final java.lang.String DIR_EXTENSION

See Also:

Constant Field Values

ATTDIR_EXTENSION

public static final java.lang.String ATTDIR_EXTENSION

See Also:

Constant Field Values

Constructor Detail

BasicAttachmentProvider

public BasicAttachmentProvider()

Method Detail

initialize

public void initialize(java.util.Properties properties)
                throws NoRequiredPropertyException,
                       java.io.IOException

Description copied from interface: WikiProvider

Initializes the page provider.

Specified by:

initialize in interface WikiProvider

NoRequiredPropertyException

java.io.IOException

getFileExtension

protected static java.lang.String getFileExtension(java.lang.String filename)

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

If file has no extension, will return "bin"

putAttachmentData

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

Description copied from interface: WikiAttachmentProvider

Put new attachment data.

Specified by:

putAttachmentData in interface WikiAttachmentProvider

ProviderException

java.io.IOException

getProviderInfo

public java.lang.String getProviderInfo()

Description copied from interface: WikiProvider

Return a valid HTML string for information. May be anything.

Specified by:

getProviderInfo in interface WikiProvider

getAttachmentData

public java.io.InputStream getAttachmentData(Attachment att)
                                      throws java.io.IOException,
                                             ProviderException

Description copied from interface: WikiAttachmentProvider

Get attachment data.

Specified by:

getAttachmentData in interface WikiAttachmentProvider

java.io.IOException

ProviderException

listAttachments

public java.util.Collection listAttachments(WikiPage page)
                                     throws ProviderException

Description copied from interface: WikiAttachmentProvider

Lists all attachments attached to a page.

Specified by:

listAttachments in interface WikiAttachmentProvider

Returns:

A collection of Attachment objects. May be empty, but never null.

ProviderException

findAttachments

public java.util.Collection findAttachments(QueryItem[] query)

Description copied from interface: WikiAttachmentProvider

Finds attachments based on the query.

Specified by:

findAttachments in interface WikiAttachmentProvider

listAllChanged

public java.util.List listAllChanged(java.util.Date timestamp)
                              throws ProviderException

Description copied from interface: WikiAttachmentProvider

Lists changed attachments since given date. Can also be used to fetch a list of all pages.

This is different from WikiPageProvider, where you basically get a list of all pages, then sort them locally. However, since some providers can be more efficient in locating recently changed files (like any database) than our non-optimized Java code, it makes more sense to fetch the whole list this way.

To get all files, call this with Date(0L);

Specified by:

listAllChanged in interface WikiAttachmentProvider

Parameters:

timestamp - List all files from this date onward.

Returns:

A List of Attachment objects, in most-recently-changed first order.

ProviderException

getAttachmentInfo

public Attachment getAttachmentInfo(WikiPage page,
                                    java.lang.String name,
                                    int version)
                             throws ProviderException

Description copied from interface: WikiAttachmentProvider

Returns info about an attachment.

Specified by:

getAttachmentInfo in interface WikiAttachmentProvider

ProviderException

getVersionHistory

public java.util.List getVersionHistory(Attachment att)

Description copied from interface: WikiAttachmentProvider

Returns version history. Each element should be an Attachment.

Specified by:

getVersionHistory in interface WikiAttachmentProvider

deleteVersion

public void deleteVersion(Attachment att)
                   throws ProviderException

Description copied from interface: WikiAttachmentProvider

Removes a specific version from the repository. The implementations should really do no more security checks, since that is the domain of the AttachmentManager. Just delete it as efficiently as you can.

Specified by:

deleteVersion in interface WikiAttachmentProvider

Parameters:

att - Attachment to be removed. The version field is checked, and thus only that version is removed.

Throws:

ProviderException - If the attachment cannot be removed for some reason.

deleteAttachment

public void deleteAttachment(Attachment att)
                      throws ProviderException

Description copied from interface: WikiAttachmentProvider

Removes an entire page from the repository. The implementations should really do no more security checks, since that is the domain of the AttachmentManager. Just delete it as efficiently as you can. You should also delete any auxiliary files and directories that belong to this attachment, IF they were created by this provider.

Specified by:

deleteAttachment in interface WikiAttachmentProvider

Parameters:

att - Attachment to delete.

Throws:

ProviderException - If the page could not be removed for some reason.