|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttachmentDataDao
This interface defines the methods for classes acting as a DAO at the level of data storage for Attachments.
Method Summary | |
---|---|
void |
afterMigrationFrom()
Perform any tasks necessary after Attachment data has been moved from this data store to another. |
java.io.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 |
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()
Prepare the data store for a migration from another type of data store. |
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 |
replaceDataForAttachment(Attachment attachment,
AttachmentDataStream dataStream)
Sets the data for attachment This method will overwrite any existing data for the attachment. |
void |
replaceDataForAttachment(Attachment attachment,
java.io.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,
java.io.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,
java.io.InputStream data)
Deprecated. Since 5.5 Use saveDataForAttachmentVersion(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.pages.Attachment, AttachmentDataStream) |
Method Detail |
---|
@Deprecated java.io.InputStream getDataForAttachment(Attachment attachment) throws AttachmentDataNotFoundException
getDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStreamType)
attachment
- the Attachment representing the data
java.lang.IllegalArgumentException
- if attachment is null
AttachmentDataNotFoundException
- if no data was foundAttachmentDataStream getDataForAttachment(Attachment attachment, AttachmentDataStreamType dataStreamType) throws AttachmentDataNotFoundException
attachment
- the Attachment representing the data
java.lang.IllegalArgumentException
- if attachment is null
AttachmentDataNotFoundException
- if no data was foundvoid removeDataForAttachment(Attachment attachment, ContentEntityObject originalContent)
attachment
- the latest version of the attachment for which the data should be removedoriginalContent
- the content the attachment belongs to
java.lang.IllegalArgumentException
- if attachment is nullvoid removeDataForAttachmentVersion(Attachment attachmentVersion, ContentEntityObject originalContent)
attachmentVersion
- the version of the attachment for which the data should be removedoriginalContent
- the content the attachment belongs to
java.lang.IllegalArgumentException
- if attachment is nullvoid moveDataForAttachmentVersion(Attachment sourceAttachmentVersion, Attachment targetAttachmentVersion)
AbstractVersionedEntityObject.getVersion()
to the other.
This method will overwrite any existing data for the target attachment version.
sourceAttachmentVersion
- the attachmenttargetAttachmentVersion
-
java.lang.IllegalArgumentException
- if the Attachment.getContent()
differsmoveAttachment(Attachment, Attachment, ContentEntityObject)
@Deprecated void saveDataForAttachment(Attachment attachment, java.io.InputStream data)
saveDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)
attachment
- the Attachment the data belongs todata
- the InputStream to be written
java.lang.IllegalArgumentException
- if attachment is null
java.lang.IllegalArgumentException
- if data is null
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.void saveDataForAttachment(Attachment attachment, AttachmentDataStream dataStream)
attachment
- the Attachment the data belongs todataStream
- the data stream to be written
java.lang.IllegalArgumentException
- if attachment is null
java.lang.IllegalArgumentException
- if data is null
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.@Deprecated void saveDataForAttachmentVersion(Attachment attachment, Attachment previousVersion, java.io.InputStream data)
saveDataForAttachmentVersion(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.pages.Attachment, AttachmentDataStream)
attachment
- the new version of the attachmentpreviousVersion
- the previous version of the attachmentdata
- the InputStream representing the data
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.void saveDataForAttachmentVersion(Attachment attachment, Attachment previousVersion, AttachmentDataStream dataStream)
attachment
- the new version of the attachmentpreviousVersion
- the previous version of the attachmentdataStream
- the InputStream representing the data
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.@Deprecated void replaceDataForAttachment(Attachment attachment, java.io.InputStream data)
replaceDataForAttachment(com.atlassian.confluence.pages.Attachment, AttachmentDataStream)
attachment
- Attachment the data belongs todata
- the data to be saved
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.void replaceDataForAttachment(Attachment attachment, AttachmentDataStream dataStream)
attachment
- Attachment the data belongs todataStream
- the data to be saved
AttachmentDataStreamSizeMismatchException
- if bytes read from the data stream does not match Attachment.getFileSize()
.boolean isAttachmentPresent(Attachment attachment)
attachment
- the Attachment to be checkedvoid moveAttachment(Attachment attachment, Attachment oldAttachment, ContentEntityObject newContent)
attachment
- the Attachment to be movedoldAttachment
- the original version of the attachmentnewContent
- the new content the Attachment belongs to
java.lang.IllegalArgumentException
- if attachment is null
java.lang.IllegalArgumentException
- if newFileName is null
java.lang.IllegalArgumentException
- if newContent is nullvoid prepareForMigrationTo()
java.lang.RuntimeException
- if there was a problemvoid afterMigrationFrom()
Implementations may circumvent hibernate, so should only be called when nobody else can see the attachment data.
java.lang.RuntimeException
- if there was a problemAttachmentDataStorageType getStorageType()
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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |