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

Class ObjectStorageAttachmentDataFileSystem

java.lang.Object

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

All Implemented Interfaces:

AttachmentDataFileSystem, AttachmentDataFileSystemInternals

public class ObjectStorageAttachmentDataFileSystem
extends Object
implements AttachmentDataFileSystem, AttachmentDataFileSystemInternals

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
com.atlassian.dc.filestore.api.compat.FilesystemPath	containerPathForAttachmentVersions(long attachmentId, long containerId, Long spaceId)
boolean	dataExistsForAttachment(AttachmentRef attachment)	Indicates whether the filesystem contains data for the given attachment
void	deleteAllAttachmentVersions(AttachmentRef attachment, AttachmentRef.Container contentEntity)	Delete all data corresponding to all versions of the given 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 the data of the specified stream type corresponding to a single attachment version
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	getAttachmentDataFile(long attachmentId, Long containerId, Long spaceId, Integer attachmentVersion, AttachmentDataStreamType dataStreamType)
com.atlassian.dc.filestore.api.compat.FilesystemPath	getPathForSpace(Long spaceId)
void	moveAttachment(AttachmentRef oldAttachment, AttachmentRef newAttachment, AttachmentRef.Container newContentEntity)	Move all data relating to one attachment to a new directory corresponding to the given new attachment and content entity.
void	moveAttachments(AttachmentRef.Container contentEntity, AttachmentRef.Space oldSpace, AttachmentRef.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(AttachmentRef sourceAttachmentVersion, AttachmentRef 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(AttachmentRef attachment, AttachmentDataStream dataStream, boolean overwrite, org.springframework.util.unit.DataSize expectedFileSize)	Save new data corresponding to the given attachment.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.impl.pages.attachments.filesystem.AttachmentDataFileSystemInternals

containerDirectoryForAttachmentVersions, getDirectoryForSpace

Constructor Detail

ObjectStorageAttachmentDataFileSystem

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

Method Detail

dataExistsForAttachment

public boolean dataExistsForAttachment(AttachmentRef attachment)

Description copied from interface: AttachmentDataFileSystem

Indicates whether the filesystem contains data for the given attachment

Specified by:

dataExistsForAttachment in interface AttachmentDataFileSystem

moveAttachment

public void moveAttachment(AttachmentRef oldAttachment,
                           AttachmentRef newAttachment,
                           AttachmentRef.Container newContentEntity)

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

newContentEntity - The content entity corresponding to the new attachment

saveAttachmentData

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

Description copied from interface: AttachmentDataFileSystem

Save new data corresponding to the given attachment.

Specified by:

saveAttachmentData in interface AttachmentDataFileSystem

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.

expectedFileSize - The expected size of the data being written

Returns:

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

deleteAllAttachmentVersions

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

Description copied from interface: AttachmentDataFileSystem

Delete all data corresponding to all versions of the given attachment

Specified by:

deleteAllAttachmentVersions in interface AttachmentDataFileSystem

Parameters:

attachment - the attachment whose data is to be deleted

contentEntity - The content entity associated with the attachment

moveDataForAttachmentVersion

public void moveDataForAttachmentVersion(AttachmentRef sourceAttachmentVersion,
                                         AttachmentRef targetAttachmentVersion)

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

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)

Description copied from interface: AttachmentDataFileSystem

Delete the data of the specified stream type 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

dataStreamType - The attachment stream type

getAttachmentData

@Nullable
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

@Nullable
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

moveAttachments

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

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

prepareForMigrationTo

public void prepareForMigrationTo()

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

prepareForMigrationTo in interface AttachmentDataFileSystem

containerPathForAttachmentVersions

@Nullable
public com.atlassian.dc.filestore.api.compat.FilesystemPath containerPathForAttachmentVersions(long attachmentId,
                                                                                               long containerId,
                                                                                               @Nullable
                                                                                               Long spaceId)

Specified by:

containerPathForAttachmentVersions in interface AttachmentDataFileSystemInternals

getAttachmentDataFile

@Nullable
public AttachmentDataFile getAttachmentDataFile(long attachmentId,
                                                @Nullable
                                                Long containerId,
                                                @Nullable
                                                Long spaceId,
                                                Integer attachmentVersion,
                                                AttachmentDataStreamType dataStreamType)

Specified by:

getAttachmentDataFile in interface AttachmentDataFileSystemInternals

getPathForSpace

@Nullable
public com.atlassian.dc.filestore.api.compat.FilesystemPath getPathForSpace(@Nullable
                                                                            Long spaceId)

Specified by:

getPathForSpace in interface AttachmentDataFileSystemInternals