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

Class ContentDirectoryStructureAttachmentDataFileSystemV004

java.lang.Object

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

All Implemented Interfaces:

AttachmentDataFileSystem, AttachmentDataFileSystemInternals

public class ContentDirectoryStructureAttachmentDataFileSystemV004
extends Object
implements AttachmentDataFileSystem, AttachmentDataFileSystemInternals

An implementation of AttachmentDataFileSystem which stores the attachment data as files on a filesystem, using the standard File API.

The files are stored within a hierarchical directory 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 directory structure is described by the following pattern: "a1/a2/ax/attachmentId.a/attachmentFile"

where a1, a2, ax are subdirectories generated from the attachment id by splitting the attachment id into up to 3 digits long substrings, 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"). For other stream types, the filename is "id.version.streamType" (e.g. "123456.1.extracted_text"). Suffix ".a" in the attachment versions folder name is added to avoid clashes between attachment id and subdirectories' name.

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 FilesystemPath representing the directory that contains all the versions of an attachment
static ContentDirectoryStructureAttachmentDataFileSystemV004	create(AttachmentDataStorageLocationResolver rootDir)
boolean	dataExistsForAttachment(AttachmentRef attachment)	Check if attachment data exists
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, not needed in v004 storage
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 attachmentVersion, AttachmentDataStream attachmentDataStream, boolean overwrite, org.springframework.util.unit.DataSize expectedFileSize)	Save attachment to the file system storage

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 ContentDirectoryStructureAttachmentDataFileSystemV004 create(AttachmentDataStorageLocationResolver rootDir)

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 attachmentVersion,
                                  AttachmentDataStream attachmentDataStream,
                                  boolean overwrite,
                                  org.springframework.util.unit.DataSize expectedFileSize)

Save attachment to the file system storage

Specified by:

saveAttachmentData in interface AttachmentDataFileSystem

Parameters:

attachmentVersion - 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:

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

containerPathForAttachmentVersions

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

Get the FilesystemPath 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 - not used

spaceId - not used

Returns:

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

getAttachmentDataFile

public AttachmentDataFile getAttachmentDataFile(long attachmentId,
                                                @Nullable
                                                Long containerId,
                                                @Nullable
                                                Long spaceId,
                                                @Nullable
                                                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 - not used

deleteSingleAttachmentVersion

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

Delete the data corresponding to a single attachment version

This method will remove 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 - not used

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

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

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

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

getPathForSpace

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

Deprecated.

since 8.1.0, not needed in v004 storage

Specified by:

getPathForSpace in interface AttachmentDataFileSystemInternals

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