Package com.atlassian.confluence.impl.pages.attachments.objectstorage

Class ObjectStorageAttachmentDataFileSystem

java.lang.Object

com.atlassian.confluence.impl.pages.attachments.objectstorage.ObjectStorageAttachmentDataFileSystem

All Implemented Interfaces:

AttachmentDataFileSystem

public class ObjectStorageAttachmentDataFileSystem
extends Object
implements AttachmentDataFileSystem

An implementation of AttachmentDataFileSystem which stores the attachment data in an object storage service (for example AWS S3), using the FileStore.Path API.

The files are stored within a hierarchical prefix structure that incorporates an attachment IDs to which the attachment data belongs to. Data corresponding to each version of the attachment are stored, as are different "streams" of data for each version (see AttachmentDataStreamType).

The prefix structure is described by the following pattern: "h1/h2/attachmentId/attachmentFile"

where h1, h2 are hashcodes generated from the attachment id and attachmentFile represents a combination of the attachment id, version and the data stream type. Attachments AttachmentDataStreamType.RAW_BINARY format has a filename that consists of the attachment id and the version separated by a dot (eg. "123456.1").

Since:

8.1.0

Constructor Summary

Constructors

Constructor	Description
ObjectStorageAttachmentDataFileSystem(com.atlassian.dc.filestore.api.FileStore.Path rootDir)

Method Summary

Modifier and Type	Method	Description
boolean	dataExistsForAttachment(AttachmentRef attachment)	Check if attachment data exists
void	deleteAllAttachmentVersions(AttachmentRef attachment, AttachmentRef.Container contentEntity)	Delete all versions for a particular attachment
void	deleteSingleAttachmentVersion(AttachmentRef attachment, AttachmentRef.Container contentEntity)	Delete the data corresponding to a single attachment version
void	deleteSingleAttachmentVersion(AttachmentRef attachment, AttachmentRef.Container contentEntity, AttachmentDataStreamType dataStreamType)	Delete an attachment version for a particular attachment
AttachmentDataStream	getAttachmentData(AttachmentRef attachment, AttachmentDataStreamType dataStreamType)	Fetches the data for a given attachment version and data stream type
AttachmentDataStream	getAttachmentData(AttachmentRef attachment, AttachmentDataStreamType dataStreamType, Optional<RangeRequest> range)	Fetches the specified range of data for a given attachment version and data stream type
AttachmentDataFile<com.atlassian.dc.filestore.api.compat.FilesystemPath>	getAttachmentDataFile(long attachmentId, Long containerId, Long spaceId, Integer attachmentVersion, AttachmentDataStreamType dataStreamType)	Deprecated. since 8.3.0
com.atlassian.dc.filestore.api.FileStore.Path	getRootDir()
AttachmentStorageVersion	getStructureVersion()	Version of the attachment storage structure.
void	moveAttachment(AttachmentRef oldAttachment, AttachmentRef newAttachment, AttachmentRef.Container newContent)	Deprecated. since 8.1.0, not needed in v004 storage
void	moveAttachments(AttachmentRef.Container contentEntity, AttachmentRef.Space oldSpace, AttachmentRef.Space newSpace)	Deprecated. since 8.1.0, not needed in v004 storage because we do not move files in v004 storage
void	moveDataForAttachmentVersion(AttachmentRef sourceAttachmentVersion, AttachmentRef targetAttachmentVersion)	Deprecated. since 8.1.0, not needed in v004 storage
void	prepareForMigrationTo()	Deprecated. since 8.1.0, not needed in v004 storage because no action needed for v004 migration
boolean	saveAttachmentData(AttachmentRef attachment, AttachmentDataStream attachmentDataStream, boolean overwrite, org.springframework.util.unit.DataSize expectedFileSize)	Save attachment to S3 object storage

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStorageAttachmentDataFileSystem

public ObjectStorageAttachmentDataFileSystem(com.atlassian.dc.filestore.api.FileStore.Path rootDir)

Method Detail

getRootDir

public com.atlassian.dc.filestore.api.FileStore.Path getRootDir()

getStructureVersion

public AttachmentStorageVersion getStructureVersion()

Description copied from interface: AttachmentDataFileSystem

Version of the attachment storage structure.

Specified by:

getStructureVersion in interface AttachmentDataFileSystem

dataExistsForAttachment

public boolean dataExistsForAttachment(AttachmentRef attachment)

Check if attachment data exists

Specified by:

dataExistsForAttachment in interface AttachmentDataFileSystem

Parameters:

attachment - reference to the attachment

Returns:

true if the attachment data is available

saveAttachmentData

public boolean saveAttachmentData(AttachmentRef attachment,
                                  AttachmentDataStream attachmentDataStream,
                                  boolean overwrite,
                                  org.springframework.util.unit.DataSize expectedFileSize)

Save attachment to S3 object storage

Specified by:

saveAttachmentData in interface AttachmentDataFileSystem

Parameters:

attachment - reference to the attachment to be stored

attachmentDataStream - source stream with attachment data

overwrite - overwrite attachment

expectedFileSize - expected file size to be written. Used only for RAW_BINARY stream

Returns:

true if the attachment was saved successfully

deleteAllAttachmentVersions

public void deleteAllAttachmentVersions(AttachmentRef attachment,
                                        AttachmentRef.Container contentEntity)

Delete all versions for a particular attachment

Specified by:

deleteAllAttachmentVersions in interface AttachmentDataFileSystem

Parameters:

attachment - the attachment for which data should be removed

contentEntity - The content entity associated with the attachment

deleteSingleAttachmentVersion

public void deleteSingleAttachmentVersion(AttachmentRef attachment,
                                          AttachmentRef.Container contentEntity)

Description copied from interface: AttachmentDataFileSystem

Delete the data corresponding to a single attachment version

Specified by:

deleteSingleAttachmentVersion in interface AttachmentDataFileSystem

Parameters:

attachment - The attachment whose data should be deleted

contentEntity - The content entity associated with the attachment

deleteSingleAttachmentVersion

public void deleteSingleAttachmentVersion(AttachmentRef attachment,
                                          AttachmentRef.Container contentEntity,
                                          AttachmentDataStreamType dataStreamType)

Delete an attachment version for a particular attachment

Specified by:

deleteSingleAttachmentVersion in interface AttachmentDataFileSystem

Parameters:

attachment - the attachment from which the version should be deleted

contentEntity - The content entity associated with the attachment

dataStreamType - The attachment stream type

getAttachmentData

public AttachmentDataStream getAttachmentData(AttachmentRef attachment,
                                              AttachmentDataStreamType dataStreamType)

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

getAttachmentData in interface AttachmentDataFileSystem

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

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

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

getAttachmentData in interface AttachmentDataFileSystem

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

getAttachmentDataFile

@Deprecated(since="8.3.0")
public AttachmentDataFile<com.atlassian.dc.filestore.api.compat.FilesystemPath> getAttachmentDataFile(long attachmentId,
                                                                                                      @Nullable
                                                                                                      Long containerId,
                                                                                                      @Nullable
                                                                                                      Long spaceId,
                                                                                                      Integer attachmentVersion,
                                                                                                      AttachmentDataStreamType dataStreamType)

Deprecated.

since 8.3.0

This method won't support S3 attachment storage. Use at your own risk.

Specified by:

getAttachmentDataFile in interface AttachmentDataFileSystem

prepareForMigrationTo

@Deprecated
public void prepareForMigrationTo()

Deprecated.

since 8.1.0, not needed in v004 storage because no action needed for v004 migration

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

prepareForMigrationTo in interface AttachmentDataFileSystem

moveDataForAttachmentVersion

@Deprecated
public void moveDataForAttachmentVersion(AttachmentRef sourceAttachmentVersion,
                                         AttachmentRef targetAttachmentVersion)

Deprecated.

since 8.1.0, not needed in v004 storage

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

moveDataForAttachmentVersion in interface AttachmentDataFileSystem

Parameters:

sourceAttachmentVersion - The attachment version containing the data

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

moveAttachment

@Deprecated
public void moveAttachment(AttachmentRef oldAttachment,
                           AttachmentRef newAttachment,
                           AttachmentRef.Container newContent)

Deprecated.

since 8.1.0, not needed in v004 storage

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

moveAttachment in interface AttachmentDataFileSystem

Parameters:

oldAttachment - The attachment whose data is to be moved

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

newContent - The content entity corresponding to the new attachment

moveAttachments

@Deprecated
public void moveAttachments(AttachmentRef.Container contentEntity,
                            AttachmentRef.Space oldSpace,
                            AttachmentRef.Space newSpace)

Deprecated.

since 8.1.0, not needed in v004 storage because we do not move files in v004 storage

Description copied from interface: AttachmentDataFileSystem

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.

Specified by:

moveAttachments in interface AttachmentDataFileSystem

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