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

Class ContentDirectoryStructureAttachmentDataFileSystemAdapter

java.lang.Object

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

All Implemented Interfaces:

AttachmentDataFileSystem, AttachmentDataFileSystemInternals

public final class ContentDirectoryStructureAttachmentDataFileSystemAdapter
extends Object
implements AttachmentDataFileSystem, AttachmentDataFileSystemInternals

The purpose of this adapter is to switch between different attachment storage structures implementations AttachmentDataFileSystem. The version 003 needs to be supported while the migration to version 004 is in progress. The class prioritises version 004 and if it can't find a file then it will fallback to version 003.

Since:

8.1.0

Method Summary

Modifier and Type	Method	Description
com.atlassian.dc.filestore.api.compat.FilesystemPath	containerPathForAttachmentVersions(long latestVersionAttachmentId, long contentId, Long spaceId)	Get the File representing the directory that contains all the versions of an attachment
static ContentDirectoryStructureAttachmentDataFileSystemAdapter	create(AttachmentDataStorageLocationResolver rootDirV003, AttachmentDataStorageLocationResolver rootDirV004, DeferredFileDeletionQueue deferredFileDeletionQueue)
boolean	dataExistsForAttachment(AttachmentRef attachment)	Indicates whether the filesystem contains data for the given attachment
void	deleteAllAttachmentVersions(AttachmentRef attachment, AttachmentRef.Container originalContent)	Delete all data corresponding to all versions of the given attachment
void	deleteSingleAttachmentVersion(AttachmentRef attachment, AttachmentRef.Container originalContent)	Delete the data corresponding to a single attachment version
void	deleteSingleAttachmentVersion(AttachmentRef attachment, AttachmentRef.Container originalContent, 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)	Deprecated. since 8.1.0.
void	moveAttachment(AttachmentRef oldAttachment, AttachmentRef newAttachment, AttachmentRef.Container newContent)	Deprecated. since 8.1.0
void	moveAttachments(AttachmentRef.Container contentEntity, AttachmentRef.Space oldSpace, AttachmentRef.Space newSpace)	Deprecated. since 8.1.0.
void	moveDataForAttachmentVersion(AttachmentRef sourceAttachmentVersion, AttachmentRef targetAttachmentVersion)	Deprecated. since 8.1.0
void	prepareForMigrationTo()	Deprecated. since 8.1.0.
boolean	saveAttachmentData(AttachmentRef attachmentVersion, AttachmentDataStream attachmentDataStream, 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

Method Detail

create

public static ContentDirectoryStructureAttachmentDataFileSystemAdapter create(AttachmentDataStorageLocationResolver rootDirV003,
                                                                              AttachmentDataStorageLocationResolver rootDirV004,
                                                                              DeferredFileDeletionQueue deferredFileDeletionQueue)

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

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

Deprecated.

since 8.1.0

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

saveAttachmentData

public boolean saveAttachmentData(AttachmentRef attachmentVersion,
                                  AttachmentDataStream attachmentDataStream,
                                  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:

attachmentVersion - The attachment to which the data should be associated

attachmentDataStream - 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)

containerPathForAttachmentVersions

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

Get the File representing the directory that contains all the versions of an attachment

Specified by:

containerPathForAttachmentVersions in interface AttachmentDataFileSystemInternals

Parameters:

latestVersionAttachmentId - this should be the ID of the latest version or the directory will not exist

contentId - the ID of the content containing the attachment

spaceId - the ID of the space the content belongs to

Returns:

the File representing the directory that contains all the versions of an attachment

getAttachmentDataFile

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

Specified by:

getAttachmentDataFile in interface AttachmentDataFileSystemInternals

deleteAllAttachmentVersions

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

Delete all data corresponding to all versions of the given attachment

This method will remove any empty folders left after removing the attachment data.

Specified by:

deleteAllAttachmentVersions in interface AttachmentDataFileSystem

Parameters:

attachment - the attachment for which data should be removed

originalContent - the content the attachment belongs to

moveDataForAttachmentVersion

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

Deprecated.

since 8.1.0

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 originalContent)

Delete the data corresponding to a single attachment version

This method will remove all attachment files and any empty folders left after removing the attachment data.

Specified by:

deleteSingleAttachmentVersion in interface AttachmentDataFileSystem

Parameters:

attachment - the attachment for which data should be removed

originalContent - the content the attachment belongs to

deleteSingleAttachmentVersion

public void deleteSingleAttachmentVersion(AttachmentRef attachment,
                                          AttachmentRef.Container originalContent,
                                          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

originalContent - The content entity associated with the attachment

dataStreamType - The attachment stream type

getPathForSpace

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

Deprecated.

since 8.1.0. Space is no longer a part of the attachment path since storage v4.

Specified by:

getPathForSpace in interface AttachmentDataFileSystemInternals

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

moveAttachments

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

Deprecated.

since 8.1.0. Space is no longer a part of the attachment path since storage v004.

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

@Deprecated
public void prepareForMigrationTo()

Deprecated.

since 8.1.0. Migration DB <-> FS should be already done and is not supported in 8.1.

Description copied from interface: AttachmentDataFileSystem

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

Specified by:

prepareForMigrationTo in interface AttachmentDataFileSystem