org.ws4d.java.attachment

Class AttachmentStore

java.lang.Object

org.ws4d.java.attachment.AttachmentStore

Direct Known Subclasses:

DefaultAttachmentStore

public abstract class AttachmentStore
extends java.lang.Object

This class allows to store the attachments. Depending on the platform the attachments are stored into files, or stay in memory.

Field Summary

Fields

Modifier and Type	Field and Description
static int	POLICY_EXT_STORAGE This attachment store policy indicates that attachments should be stored on external media (file system, database, etc.) rather than kept in memory.
static int	POLICY_MEM_BUFFER This attachment store policy indicates that attachments should be kept within memory rather than stored on external media (file system, database, etc.).

Constructor Summary

Constructors

Constructor and Description
AttachmentStore()

Method Summary

Modifier and Type	Method and Description
abstract void	cleanup() Cleans up the attachment store.
abstract void	deleteAttachments(java.lang.String uniqueId) Delete the attachment from file system if is FileAttachment and from AttachmentStore.
java.lang.String	getAttachmentPathPrefix()
static AttachmentStore	getInstance()
static int	getStorePolicy() Returns the policy for storing attachment raw data used within this current runtime.
abstract boolean	isAvailable(java.lang.String uniqueId, java.lang.String cid) Returns true if attachment is available.
abstract void	prepareForAttachments(java.lang.String uniqueId) Prepares the attachment map for the new attachments with given uniqueId.
abstract IncomingAttachment	resolve(java.lang.String uniqueId, java.lang.String cid, long timeToWait) Resolves an attachment by uniqueId and cid.
void	setAttachmentPathPrefix(java.lang.String prefix)
static void	setStorePolicy(int newStorePolicy)
abstract void	store(java.lang.String uniqueId, java.lang.String cid, boolean isStreamingType, ContentType contentType, java.io.InputStream from) Stores an attachment by uniqueId and cid.

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_MEM_BUFFER

public static final int POLICY_MEM_BUFFER

This attachment store policy indicates that attachments should be kept within memory rather than stored on external media (file system, database, etc.).

See Also:

Constant Field Values

POLICY_EXT_STORAGE

public static final int POLICY_EXT_STORAGE

This attachment store policy indicates that attachments should be stored on external media (file system, database, etc.) rather than kept in memory.

See Also:

Constant Field Values

Constructor Detail

AttachmentStore

public AttachmentStore()

Method Detail

getInstance

public static AttachmentStore getInstance()
                                   throws AttachmentException

Throws:

AttachmentException

getStorePolicy

public static int getStorePolicy()

Returns the policy for storing attachment raw data used within this current runtime.

Returns:

the attachment store policy of the current runtime/platform

See Also:

POLICY_MEM_BUFFER, POLICY_EXT_STORAGE

setStorePolicy

public static void setStorePolicy(int newStorePolicy)

resolve

public abstract IncomingAttachment resolve(java.lang.String uniqueId,
                                           java.lang.String cid,
                                           long timeToWait)
                                    throws AttachmentException

Resolves an attachment by uniqueId and cid.

Parameters:

uniqueId -

cid -

Returns:

attachment to resolve.

Throws:

AttachmentException

store

public abstract void store(java.lang.String uniqueId,
                           java.lang.String cid,
                           boolean isStreamingType,
                           ContentType contentType,
                           java.io.InputStream from)

Stores an attachment by uniqueId and cid.

Parameters:

uniqueId -

cid -

isStreamingType -

contentType -

from -

isAvailable

public abstract boolean isAvailable(java.lang.String uniqueId,
                                    java.lang.String cid)

Returns true if attachment is available.

Parameters:

uniqueId -

cid -

Returns:

true if is available, else false.

cleanup

public abstract void cleanup()

Cleans up the attachment store.

deleteAttachments

public abstract void deleteAttachments(java.lang.String uniqueId)

Delete the attachment from file system if is FileAttachment and from AttachmentStore.

prepareForAttachments

public abstract void prepareForAttachments(java.lang.String uniqueId)

Prepares the attachment map for the new attachments with given uniqueId.

Parameters:

uniqueId -

getAttachmentPathPrefix

public java.lang.String getAttachmentPathPrefix()

setAttachmentPathPrefix

public void setAttachmentPathPrefix(java.lang.String prefix)