com.atlassian.confluence.pages.persistence.dao.filesystem

Interface AttachmentDataFileSystem

All Known Implementing Classes:

DualAttachmentDataFileSystemPrimaryCloud, DualAttachmentDataFileSystemPrimaryLocal, FileStoreAttachmentDataFileSystem, HierarchicalMultiStreamAttachmentDataFileSystem, TrackingAttachmentDataFileSystem

@Internal
public interface AttachmentDataFileSystem

Represents the filesystem used to store attachment data files.

Since:

5.5

Method Summary

Modifier and Type	Method and Description
boolean	dataExistsForAttachment(Attachment attachment) Indicates whether the filesystem contains data for the given attachment
void	deleteAllAttachmentVersions(Attachment attachment, ContentEntityObject contentEntity) Delete all data corresponding to all versions of the given attachment
void	deleteSingleAttachmentVersion(Attachment attachment, ContentEntityObject contentEntity) Delete the data corresponding to a single attachment version
void	deleteSingleAttachmentVersion(Attachment attachment, ContentEntityObject contentEntity, AttachmentDataStreamType dataStreamType) Delete the data of the specified stream type corresponding to a single attachment version
AttachmentDataStream	getAttachmentData(Attachment attachment, AttachmentDataStreamType dataStreamType) Fetches the data for a given attachment version and data stream type
AttachmentDataStream	getAttachmentData(Attachment attachment, AttachmentDataStreamType dataStreamType, Optional<RangeRequest> range) Fetches the specified range of data for a given attachment version and data stream type
void	moveAttachment(Attachment oldAttachment, Attachment newAttachment, ContentEntityObject newContentEntity) Move all data relating to one attachment to a new directory corresponding to the given new attachment and content entity.
void	moveAttachments(ContentEntityObject contentEntity, Space oldSpace, Space newSpace) Move all data for all versions of all attachments corresponding to the given content entity in the given space, to the same entity in a different space.
void	moveDataForAttachmentVersion(Attachment sourceAttachmentVersion, Attachment targetAttachmentVersion) Move the data associated with one attachment version, to being associated with a different attachment version
void	prepareForMigrationTo() Prepare the data store for a migration from another type of data store.
boolean	saveAttachmentData(Attachment attachment, AttachmentDataStream dataStream, boolean overwrite) Save new data corresponding to the given attachment.

Method Detail

dataExistsForAttachment

boolean dataExistsForAttachment(Attachment attachment)

Indicates whether the filesystem contains data for the given attachment

moveAttachment

void moveAttachment(Attachment oldAttachment,
                    Attachment newAttachment,
                    ContentEntityObject newContentEntity)

Move all data relating to one attachment to a new directory corresponding to the given new attachment and content entity.

Parameters:

oldAttachment - The attachment whose data is to be moved

newAttachment - The attachment to which the data should be moved to

newContentEntity - The content entity corresponding to the new attachment

saveAttachmentData

boolean saveAttachmentData(Attachment attachment,
                           AttachmentDataStream dataStream,
                           boolean overwrite)

Save new data corresponding to the given attachment.

Parameters:

attachment - The attachment to which the data should be associated

dataStream - The new data

overwrite - If true, any existing data will be overwritten. If false, does nothing if data already exists.

Returns:

true if the data was written, false otherwise (e.g. no overwrite)

deleteAllAttachmentVersions

void deleteAllAttachmentVersions(Attachment attachment,
                                 ContentEntityObject contentEntity)

Delete all data corresponding to all versions of the given attachment

Parameters:

attachment - the attachment whose data is to be deleted

contentEntity - The content entity associated with the attachment

moveDataForAttachmentVersion

void moveDataForAttachmentVersion(Attachment sourceAttachmentVersion,
                                  Attachment targetAttachmentVersion)

Move the data associated with one attachment version, to being associated with a different attachment version

Parameters:

sourceAttachmentVersion - The attachment version containing the data

targetAttachmentVersion - The attachment version to which the data should be moved

deleteSingleAttachmentVersion

void deleteSingleAttachmentVersion(Attachment attachment,
                                   ContentEntityObject contentEntity)

Delete the data corresponding to a single attachment version

Parameters:

attachment - The attachment whose data should be deleted

contentEntity - The content entity associated with the attachment

deleteSingleAttachmentVersion

void deleteSingleAttachmentVersion(Attachment attachment,
                                   ContentEntityObject contentEntity,
                                   AttachmentDataStreamType dataStreamType)

Delete the data of the specified stream type corresponding to a single attachment version

Parameters:

attachment - The attachment whose data should be deleted

contentEntity - The content entity associated with the attachment

dataStreamType - The attachment stream type

Since:

6.5

getAttachmentData

AttachmentDataStream getAttachmentData(Attachment attachment,
                                       AttachmentDataStreamType dataStreamType)

Fetches the data for a given attachment version and data stream type

Parameters:

attachment - The attachment version for which the data is to be fetched

dataStreamType - The type of the data stream to be fetched

Returns:

The AttachmentDataStream containing the result

getAttachmentData

AttachmentDataStream getAttachmentData(Attachment attachment,
                                       AttachmentDataStreamType dataStreamType,
                                       Optional<RangeRequest> range)

Fetches the specified range of data for a given attachment version and data stream type

Parameters:

attachment - The attachment version for which the data is to be fetched

dataStreamType - The type of the data stream to be fetched

range - The range of the data stream to be fetched

Returns:

The AttachmentDataStream containing the result

moveAttachments

void moveAttachments(ContentEntityObject contentEntity,
                     Space oldSpace,
                     Space newSpace)

Move all data for all versions of all attachments corresponding to the given content entity in the given space, to the same entity in a different space.

Parameters:

contentEntity - The content entity whose attachment data is to be moved

oldSpace - The original space of the content entity

newSpace - The new space of the content entity

prepareForMigrationTo

void prepareForMigrationTo()

Prepare the data store for a migration from another type of data store.