Package com.atlassian.confluence.pages.persistence.dao

Interface AttachmentDataDao

All Known Subinterfaces:

NonTransactionalAttachmentDataDao, TransactionalAttachmentDataDao

All Known Implementing Classes:

FileSystemAttachmentDataDao, FileSystemAttachmentDataDao, HibernateAttachmentDataDao

public interface AttachmentDataDao

This interface defines the methods for classes acting as a DAO at the level of data storage for Attachments.

Method Summary

Modifier and Type	Method	Description
void	afterMigrationFrom()	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8, no replacement
InputStream	getDataForAttachment(Attachment attachment)	Deprecated. Since 5.5 Use getDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStreamType)
AttachmentDataStream	getDataForAttachment(Attachment attachment, AttachmentDataStreamType dataStreamType)	Grabs the AttachmentData object for an Attachment
AttachmentDataStream	getDataForAttachment(Attachment attachment, AttachmentDataStreamType dataStreamType, Optional<RangeRequest> range)	Grabs the AttachmentData object for an Attachment
AttachmentDataStorageType	getStorageType()	Returns the storage type.
boolean	isAttachmentPresent(Attachment attachment)	Check that an attachment exists
void	moveAttachment(Attachment attachment, Attachment oldAttachment, ContentEntityObject newContent)	Moves an attachment to a new file name or content object
void	moveDataForAttachmentVersion(Attachment sourceAttachmentVersion, Attachment targetAttachmentVersion)	Moves the attachment data from one AbstractVersionedEntityObject.getVersion() to the other.
void	prepareForMigrationTo()	Deprecated, for removal: This API element is subject to removal in a future version. since 8.8, no replacement
void	removeDataForAttachment(Attachment attachment, ContentEntityObject originalContent)	Removes all attachment data for the given attachment.
void	removeDataForAttachmentVersion(Attachment attachmentVersion, ContentEntityObject originalContent)	Removes the attachment data for the given attachment version.
void	removeDataForAttachmentVersion(Attachment attachmentVersion, ContentEntityObject originalContent, AttachmentDataStreamType dataStreamType)	Removes the attachment data of the specific stream type for the given attachment version.
void	replaceDataForAttachment(Attachment attachment, AttachmentDataStream dataStream)	Sets the data for attachment
void	replaceDataForAttachment(Attachment attachment, InputStream data)	Deprecated. Since 5.5 Use replaceDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)
void	saveDataForAttachment(Attachment attachment, AttachmentDataStream dataStream)	Saves data to the attachment data store
void	saveDataForAttachment(Attachment attachment, InputStream data)	Deprecated. Since 5.5 Use saveDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)
void	saveDataForAttachmentVersion(Attachment attachment, Attachment previousVersion, AttachmentDataStream dataStream)	Saves data to the attachment data store, for an attachment that has been updated.
void	saveDataForAttachmentVersion(Attachment attachment, Attachment previousVersion, InputStream data)	Deprecated. Since 5.5 Use saveDataForAttachmentVersion(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.pages.Attachment, AttachmentDataStream)

Method Detail

getDataForAttachment

@Deprecated
InputStream getDataForAttachment(Attachment attachment)
                          throws AttachmentDataNotFoundException

Deprecated.

Since 5.5 Use getDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStreamType)

Grabs the AttachmentData object for an Attachment

Parameters:

attachment - the Attachment representing the data

Returns:

an AttachmentData object

Throws:

IllegalArgumentException - if attachment is null

AttachmentDataNotFoundException - if no data was found

getDataForAttachment

AttachmentDataStream getDataForAttachment(Attachment attachment,
                                          AttachmentDataStreamType dataStreamType)
                                   throws AttachmentDataNotFoundException

Grabs the AttachmentData object for an Attachment

Parameters:

attachment - the Attachment representing the data

Returns:

an AttachmentData object

Throws:

IllegalArgumentException - if attachment is null

AttachmentDataNotFoundException - if no data was found

getDataForAttachment

AttachmentDataStream getDataForAttachment(Attachment attachment,
                                          AttachmentDataStreamType dataStreamType,
                                          Optional<RangeRequest> range)
                                   throws AttachmentDataNotFoundException

Grabs the AttachmentData object for an Attachment

Parameters:

attachment - the Attachment representing the data

dataStreamType - the stream type of attachment

range - the range of attachment data

Returns:

an AttachmentData object

Throws:

IllegalArgumentException - if attachment is null

AttachmentDataNotFoundException - if no data was found

removeDataForAttachment

void removeDataForAttachment(Attachment attachment,
                             ContentEntityObject originalContent)

Removes all attachment data for the given attachment. Since Confluence 4.2 the contract of this method has been clarified. It now removes all versions of the given attachment.

Parameters:

attachment - the latest version of the attachment for which the data should be removed

originalContent - the content the attachment belongs to

Throws:

IllegalArgumentException - if attachment is null

removeDataForAttachmentVersion

void removeDataForAttachmentVersion(Attachment attachmentVersion,
                                    ContentEntityObject originalContent)

Removes the attachment data for the given attachment version.

Parameters:

attachmentVersion - the version of the attachment for which the data should be removed

originalContent - the content the attachment belongs to

Throws:

IllegalArgumentException - if attachment is null

Since:

4.3

removeDataForAttachmentVersion

void removeDataForAttachmentVersion(Attachment attachmentVersion,
                                    ContentEntityObject originalContent,
                                    AttachmentDataStreamType dataStreamType)

Removes the attachment data of the specific stream type for the given attachment version.

Parameters:

attachmentVersion - the version of the attachment for which the data should be removed

originalContent - the content the attachment belongs to

dataStreamType - the data stream type

Throws:

IllegalArgumentException - if attachment is null

Since:

6.5

moveDataForAttachmentVersion

void moveDataForAttachmentVersion(Attachment sourceAttachmentVersion,
                                  Attachment targetAttachmentVersion)

Moves the attachment data from one AbstractVersionedEntityObject.getVersion() to the other.

This method will overwrite any existing data for the target attachment version.

Parameters:

sourceAttachmentVersion - the attachment

targetAttachmentVersion -

Throws:

IllegalArgumentException - if the Attachment.getContainer() differs

Since:

4.3

See Also:

moveAttachment(Attachment, Attachment, ContentEntityObject)

saveDataForAttachment

@Deprecated
void saveDataForAttachment(Attachment attachment,
                           InputStream data)

Deprecated.

Since 5.5 Use saveDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)

Saves data to the attachment data store

Parameters:

attachment - the Attachment the data belongs to

data - the InputStream to be written

Throws:

IllegalArgumentException - if attachment is null

IllegalArgumentException - if data is null

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

saveDataForAttachment

void saveDataForAttachment(Attachment attachment,
                           AttachmentDataStream dataStream)

Saves data to the attachment data store

Parameters:

attachment - the Attachment the data belongs to

dataStream - the data stream to be written

Throws:

IllegalArgumentException - if attachment is null

IllegalArgumentException - if data is null

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

Since:

5.5

saveDataForAttachmentVersion

@Deprecated
void saveDataForAttachmentVersion(Attachment attachment,
                                  Attachment previousVersion,
                                  InputStream data)

Deprecated.

Since 5.5 Use saveDataForAttachmentVersion(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.pages.Attachment, AttachmentDataStream)

Saves data to the attachment data store, for an attachment that has been updated.

This method assumes that the attachment has already been saved.

Parameters:

attachment - the new version of the attachment

previousVersion - the previous version of the attachment

data - the InputStream representing the data

Throws:

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

saveDataForAttachmentVersion

void saveDataForAttachmentVersion(Attachment attachment,
                                  Attachment previousVersion,
                                  AttachmentDataStream dataStream)

Saves data to the attachment data store, for an attachment that has been updated.

This method assumes that the attachment has already been saved.

Parameters:

attachment - the new version of the attachment

previousVersion - the previous version of the attachment

dataStream - the InputStream representing the data

Throws:

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

Since:

5.5

replaceDataForAttachment

@Deprecated
void replaceDataForAttachment(Attachment attachment,
                              InputStream data)

Deprecated.

Since 5.5 Use replaceDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)

Sets the data for attachment

This method will overwrite any existing data for the attachment.

Parameters:

attachment - Attachment the data belongs to

data - the data to be saved

Throws:

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

replaceDataForAttachment

void replaceDataForAttachment(Attachment attachment,
                              AttachmentDataStream dataStream)

Sets the data for attachment

This method will overwrite any existing data for the attachment.

Parameters:

attachment - Attachment the data belongs to

dataStream - the data to be saved

Throws:

AttachmentDataStreamSizeMismatchException - if bytes read from the data stream does not match Attachment.getFileSize().

Since:

5.5

isAttachmentPresent

boolean isAttachmentPresent(Attachment attachment)

Check that an attachment exists

Parameters:

attachment - the Attachment to be checked

moveAttachment

void moveAttachment(Attachment attachment,
                    Attachment oldAttachment,
                    ContentEntityObject newContent)

Moves an attachment to a new file name or content object

Parameters:

attachment - the Attachment to be moved

oldAttachment - the original version of the attachment

newContent - the new content the Attachment belongs to

Throws:

IllegalArgumentException - if attachment is null

IllegalArgumentException - if newFileName is null

IllegalArgumentException - if newContent is null

prepareForMigrationTo

@Deprecated(forRemoval=true,
            since="8.8")
void prepareForMigrationTo()

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.8, no replacement

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

Classes implementing this method will perform any tasks necessary to allow the data store to be used.

Implementations may circumvent hibernate, so should only be called when nobody else can see the attachment data.

Throws:

RuntimeException - if there was a problem

afterMigrationFrom

@Deprecated(forRemoval=true,
            since="8.8")
void afterMigrationFrom()

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.8, no replacement

Perform any tasks necessary after Attachment data has been moved from this data store to another.

Implementations may circumvent hibernate, so should only be called when nobody else can see the attachment data.

Throws:

RuntimeException - if there was a problem

getStorageType

AttachmentDataStorageType getStorageType()

Returns the storage type.

The client code should be storage agnostic in general. Thus this method should only be used in rare cases in order to hide operations which are known to be not implemented for the specific type.

Returns:

the storage type

Since:

4.3