com.atlassian.confluence.pages

Class Attachment

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.core.AbstractVersionedEntityObject

com.atlassian.confluence.core.AbstractLabelableEntityObject

com.atlassian.confluence.core.ContentEntityObject

com.atlassian.confluence.core.SpaceContentEntityObject

com.atlassian.confluence.pages.Attachment

All Implemented Interfaces:

com.atlassian.bonnie.search.SearchableAttachment, com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, RelatableEntity, EditableLabelable, Labelable, Contained<ContentEntityObject>, ContentConvertible, Spaced, Serializable, Cloneable, Comparable<ContentEntityObject>

public class Attachment
extends SpaceContentEntityObject
implements com.atlassian.bonnie.search.SearchableAttachment, Addressable, HasLinkWikiMarkup, ContentConvertible, Contained<ContentEntityObject>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attachment.Type An enum of basic Attachment types with a text description of each type.

Field Summary

Fields

Modifier and Type	Field and Description
static String	API_REVISION
static String	API_REVISION_V2
static String	CONTENT_TYPE
static String	DOWNLOAD_PATH_BASE The download path for an attachment is composed with this base, see getDownloadPathWithoutEncoding() for an example.
static String	PROFILE_PICTURE_COMMENT
static String	PROP_FILE_STORE_ID
static String	PROP_FILESIZE
static String	PROP_HIDDEN
static String	PROP_MEDIA_TYPE
static String	PROP_MINOR_EDIT

Fields inherited from class com.atlassian.confluence.core.ContentEntityObject

COLLABORATIVE_EDITING_UUID, CONFLUENCE_RECOVERY, CONFLUENCE_RECOVERY_WITH_EXTERNAL_CHANGE, CONTENT_RESTORED_SYNC_REV_SOURCE, CREATED, CURRENT, DELETED, DRAFT, DUMMY_SYNC_REV, LIMITED_MODE_SYNC_REV_SOURCE, MODIFIED, SHARE_ID, SYNC_REV, SYNC_REV_SOURCE, SYNCHRONY_ACK_SYNC_REV_SOURCE, SYNCHRONY_RECOVERY, SYNCHRONY_RECOVERY_WITH_EXTERNAL_CHANGE, SYNCHRONY_SYNC_REV_SOURCE

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

INITIAL_VERSION

Fields inherited from interface com.atlassian.confluence.content.Content

UNSET

Constructor Summary

Constructors

Constructor and Description
Attachment()
Attachment(@NonNull String fileName, @NonNull String mediaType, long fileSize, String versionComment) Constructs a new Attachment.
Attachment(@NonNull String fileName, @NonNull String mediaType, long fileSize, String versionComment, boolean minorEdit)

Method Summary

Modifier and Type	Method and Description
Object	clone()
Attachment	copy()
Attachment	copyLatestVersion() Will copy all detail information of an attachment including : - Content Properties - File Name - File Size - Content Type - And set version is 1
boolean	equals(Object o)
String	getComment() Deprecated. Since 5.7. Use ContentEntityObject.getVersionComment() instead
@Nullable ContentEntityObject	getContainer()
ContentId	getContentId() Returns the ContentId for this entity object, if it implements ContentConvertible.
InputStream	getContentsAsStream() Deprecated. since 5.5. Use AttachmentManager.getAttachmentData(Attachment)
@NonNull String	getContentType() Deprecated. Since 5.7. Use getMediaType() instead
ContentType	getContentTypeObject()
static String	getDescriptionForMimeType(String mimeType, String fileExtension)
String	getDisplayTitle() Returns the display title.
String	getDownloadPath()
String	getDownloadPath(String attachmentPath, boolean addVersionInfo) Returns the download path of the attachment for a given attachmentPath prefix.
String	getDownloadPathWithoutEncoding()
String	getDownloadPathWithoutVersion() Returns the download path without any version info.
String	getDownloadPathWithoutVersionOrApiRevision() Returns the download path without any version info or API revision.
String	getExportPath()
String	getExportPathForThumbnail()
String	getFileExtension() Returns the file extension of the attachment.
@NonNull String	getFileName()
long	getFileSize()
String	getFileStoreId()
protected Collection	getImageDetailsDTO() accessor methods provided for hibernate proxy use only.
String	getLinkWikiMarkup()
@NonNull String	getMediaType()
String	getNameForComparison() Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
String	getNiceFileSize()
String	getNiceType()
Collection<com.atlassian.bonnie.Searchable>	getSearchableDependants()
Space	getSpace()
String	getType() An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
@Nullable String	getUrlPath()
VersionChildOwnerPolicy	getVersionChildPolicy(ContentType contentType) Returns the right VersionChildOwnerPolicy depending on the passed contentType.
int	hashCode()
boolean	isHidden() Indicates whether this attachment is supposed to be strictly hidden from displaying and searching Hidden attachment is not indexable Hidden attachment manipulation will not trigger external notification events
boolean	isIndexable() Only the current version of a non-hidden attachment is indexable (until we can deal with old objects in search results) We also don't want to index attachments associated with drafts or global descriptions or hidden attachments
boolean	isMinorEdit() Indicates whether this attachment is supposed to be hidden under normal circumstances.
boolean	isUserProfilePicture() Determines whether the Attachment is a user's profile picture
void	setContainer(ContentEntityObject content)
void	setContentType(@NonNull String contentType) Deprecated. Since 5.7. Use setMediaType(java.lang.String) instead
void	setFileName(@NonNull String fileName)
void	setFileSize(long fileSize)
void	setFileStoreId(String fileStoreId)
void	setHidden(boolean hidden)
protected void	setImageDetailsDTO(Set imageDetailDTOs)
void	setMediaType(@NonNull String mediaType)
void	setMinorEdit(boolean minorEdit)
boolean	shouldConvertToContent()
String	toString()

Methods inherited from class com.atlassian.confluence.core.SpaceContentEntityObject

convertToHistoricalVersion, getSpaceKey, isInSpace, setSpace

Methods inherited from class com.atlassian.confluence.core.ContentEntityObject

addAttachment, addComment, addCustomContent, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, applyChildVersioningPolicy, applyChildVersioningPolicy, compareTo, ensureAttachmentBelongsToContent, getAttachmentManager, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getAttachmentUrlPath, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getCollaborativeEditingUuid, getComments, getContainerContent, getContentPermission, getContentPermissionSet, getContentStatus, getContentStatusObject, getDefaultBodyType, getEntity, getExcerpt, getIdAsString, getLatestVersionId, getLatestVersionsOfAttachments, getLowerTitle, getOriginalVersionId, getOutgoingLinks, getPermissions, getProperties, getReferralLinks, getRenderedVersionComment, getSelector, getShareId, getSynchronyRevision, getSynchronyRevisionSource, getTitle, getTrackbackLinks, getTypeEnum, getVersionComment, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isDraft, isUnpublished, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeCustomContent, removeOutgoingLink, removeReferralLink, removeTrackbackLink, replaceContentProperties, restore, restoreDependents, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setCollaborativeEditingUuid, setComments, setContainerContent, setContentPropertiesFrom, setContentStatus, setOriginalVersion, setOriginalVersionId, setOutgoingLinks, setReferralLinks, setShareId, setSynchronyRevision, setSynchronyRevisionSource, setTitle, setTrackbackLinks, setVersionComment, sharedAccessAllowed, sharedAccessAllowed, toPageContext, trash, trashDependents, wasCreatedBy

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject

addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, removeLabelling, setLabellings

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

getConfluenceRevision, getLatestVersion, getVersion, isLatestVersion, isNew, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Methods inherited from interface com.atlassian.confluence.pages.ContentConvertible

getSelector

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable

getId, isPersistent

Field Detail

PROP_MEDIA_TYPE

public static final String PROP_MEDIA_TYPE

See Also:

Constant Field Values

PROP_FILESIZE

public static final String PROP_FILESIZE

See Also:

Constant Field Values

PROP_MINOR_EDIT

public static final String PROP_MINOR_EDIT

See Also:

Constant Field Values

PROP_HIDDEN

public static final String PROP_HIDDEN

See Also:

Constant Field Values

PROP_FILE_STORE_ID

public static final String PROP_FILE_STORE_ID

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

PROFILE_PICTURE_COMMENT

public static final String PROFILE_PICTURE_COMMENT

See Also:

Constant Field Values

API_REVISION

public static final String API_REVISION

See Also:

Constant Field Values

API_REVISION_V2

public static final String API_REVISION_V2

See Also:

Constant Field Values

DOWNLOAD_PATH_BASE

public static final String DOWNLOAD_PATH_BASE

The download path for an attachment is composed with this base, see getDownloadPathWithoutEncoding() for an example.

Constructor Detail

Attachment

public Attachment()

Attachment

public Attachment(@NonNull String fileName,
                  @NonNull String mediaType,
                  long fileSize,
                  String versionComment,
                  boolean minorEdit)

Attachment

public Attachment(@NonNull String fileName,
                  @NonNull String mediaType,
                  long fileSize,
                  String versionComment)

Constructs a new Attachment.

Method Detail

getFileName

public @NonNull String getFileName()

Specified by:

getFileName in interface com.atlassian.bonnie.search.SearchableAttachment

setFileName

public void setFileName(@NonNull String fileName)

getMediaType

public @NonNull String getMediaType()

setMediaType

public void setMediaType(@NonNull String mediaType)

getContentType

@Deprecated
public @NonNull String getContentType()

Deprecated. Since 5.7. Use getMediaType() instead

Specified by:

getContentType in interface com.atlassian.bonnie.search.SearchableAttachment

setContentType

@Deprecated
public void setContentType(@NonNull String contentType)

Deprecated. Since 5.7. Use setMediaType(java.lang.String) instead

getContainer

public @Nullable ContentEntityObject getContainer()

Specified by:

getContainer in interface Contained<ContentEntityObject>

Returns:

the owner of this content object. Can be null.

setContainer

public void setContainer(ContentEntityObject content)

getComment

@Deprecated
public String getComment()

Deprecated. Since 5.7. Use ContentEntityObject.getVersionComment() instead

Specified by:

getComment in interface com.atlassian.bonnie.search.SearchableAttachment

isMinorEdit

public boolean isMinorEdit()

Indicates whether this attachment is supposed to be hidden under normal circumstances. At the moment this is only used to avoid sending notifications and to hide them in the activity stream. Future usages should be hiding them by default in the attachment macro output

Returns:

true, if the attachment is hidden

setMinorEdit

public void setMinorEdit(boolean minorEdit)

getFileStoreId

public String getFileStoreId()

Returns:

FileStore ID of the binary data of this attachment

Since:

5.9

setFileStoreId

public void setFileStoreId(String fileStoreId)

Since:

5.9

isHidden

public boolean isHidden()

Indicates whether this attachment is supposed to be strictly hidden from displaying and searching Hidden attachment is not indexable Hidden attachment manipulation will not trigger external notification events

Returns:

true, if the attachment is hidden

setHidden

public void setHidden(boolean hidden)

getFileSize

public long getFileSize()

Returns:

The size (in bytes) of the attachment's raw binary data

setFileSize

public void setFileSize(long fileSize)

getNiceFileSize

public String getNiceFileSize()

Specified by:

getNiceFileSize in interface com.atlassian.bonnie.search.SearchableAttachment

getNiceType

public String getNiceType()

Specified by:

getNiceType in interface com.atlassian.bonnie.search.SearchableAttachment

Returns:

A nice type for this file if possible (eg "PDF" or "Word") - or null if no nice type can be recognised

getType

public String getType()

Description copied from class: ContentEntityObject

An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

Specified by:

getType in interface ContentTypeAware

Specified by:

getType in class ContentEntityObject

Returns:

the content type

getDisplayTitle

public String getDisplayTitle()

Description copied from class: ContentEntityObject

Returns the display title. Some entities don't have titles for identification. For example, personal information objects use the user's fullname. Override this method to provide a custom title.

Specified by:

getDisplayTitle in interface Addressable

Overrides:

getDisplayTitle in class ContentEntityObject

Returns:

the display title

getUrlPath

public @Nullable String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in class ContentEntityObject

getSearchableDependants

public Collection<com.atlassian.bonnie.Searchable> getSearchableDependants()

Specified by:

getSearchableDependants in interface com.atlassian.bonnie.Searchable

Overrides:

getSearchableDependants in class ContentEntityObject

isUserProfilePicture

public boolean isUserProfilePicture()

Determines whether the Attachment is a user's profile picture

Returns:

true if it is attached to a PersonalInformation object and has the correct comment

isIndexable

public boolean isIndexable()

Only the current version of a non-hidden attachment is indexable (until we can deal with old objects in search results) We also don't want to index attachments associated with drafts or global descriptions or hidden attachments

Specified by:

isIndexable in interface com.atlassian.bonnie.Searchable

Overrides:

isIndexable in class SpaceContentEntityObject

getDownloadPath

public String getDownloadPath()

Specified by:

getDownloadPath in interface com.atlassian.bonnie.search.SearchableAttachment

getDownloadPathWithoutVersion

public String getDownloadPathWithoutVersion()

Returns the download path without any version info.

getDownloadPathWithoutVersionOrApiRevision

public String getDownloadPathWithoutVersionOrApiRevision()

Returns the download path without any version info or API revision.

Since:

5.10

getDownloadPath

public String getDownloadPath(String attachmentPath,
                              boolean addVersionInfo)

Returns the download path of the attachment for a given attachmentPath prefix. It basically appends the filename and some meta info to form the path.

getDownloadPathWithoutEncoding

public String getDownloadPathWithoutEncoding()

getExportPath

public String getExportPath()

getExportPathForThumbnail

public String getExportPathForThumbnail()

getContentsAsStream

@Deprecated
public InputStream getContentsAsStream()
                                            throws IOException

Deprecated. since 5.5. Use AttachmentManager.getAttachmentData(Attachment)

Specified by:

getContentsAsStream in interface com.atlassian.bonnie.search.SearchableAttachment

Throws:

IOException

toString

public String toString()

Overrides:

toString in class ContentEntityObject

getNameForComparison

public String getNameForComparison()

Description copied from class: ContentEntityObject

Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.

Overrides:

getNameForComparison in class SpaceContentEntityObject

equals

public boolean equals(Object o)

Overrides:

equals in class ContentEntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class SpaceContentEntityObject

getFileExtension

public String getFileExtension()

Returns the file extension of the attachment. If there is no extension, an empty string is returned.

Returns:

the file extension of the attachment in lower case

getDescriptionForMimeType

public static String getDescriptionForMimeType(String mimeType,
                                               String fileExtension)

Parameters:

mimeType - the mime type to be described. Should not be null

fileExtension - the file extension to help with the deriving of the description.

Returns:

A more displayable description for the supplied mime type. If a blank String is supplied then null will be returned.

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

Overrides:

getSpace in class SpaceContentEntityObject

Returns:

the space of the owning content if it can be associated with a space (i.e. of type Spaced), or null otherwise.

getLinkWikiMarkup

public String getLinkWikiMarkup()

Specified by:

getLinkWikiMarkup in interface HasLinkWikiMarkup

Returns:

the wiki markup used to link to this content

getImageDetailsDTO

protected Collection getImageDetailsDTO()

accessor methods provided for hibernate proxy use only. use ImageDetailsManager.getImageDetails(Attachment attachment)

setImageDetailsDTO

protected void setImageDetailsDTO(Set imageDetailDTOs)

clone

public Object clone()

Overrides:

clone in class ContentEntityObject

copy

public Attachment copy()

getVersionChildPolicy

public VersionChildOwnerPolicy getVersionChildPolicy(ContentType contentType)

Description copied from interface: Versioned

Returns the right VersionChildOwnerPolicy depending on the passed contentType. By default, VersionChildOwnerPolicy.currentVersion is returned

Right now, this is only enforced for children with content type Attachment or Comment

Specified by:

getVersionChildPolicy in interface Versioned

Overrides:

getVersionChildPolicy in class AbstractVersionedEntityObject

getContentTypeObject

public ContentType getContentTypeObject()

Specified by:

getContentTypeObject in interface ContentConvertible

Returns:

the api ContentType that this ContentConvertible converts to

getContentId

public ContentId getContentId()

Description copied from class: ContentEntityObject

Returns the ContentId for this entity object, if it implements ContentConvertible.

Subclasses implementing ContentConvertible must override this method.

Specified by:

getContentId in interface ContentConvertible

Overrides:

getContentId in class ContentEntityObject

Returns:

the ContentId representation of this object's id

shouldConvertToContent

public boolean shouldConvertToContent()

Specified by:

shouldConvertToContent in interface ContentConvertible

Returns:

true if the implementer wants to be part of the core API (default value), false otherwise

copyLatestVersion

public Attachment copyLatestVersion()

Will copy all detail information of an attachment including : - Content Properties - File Name - File Size - Content Type - And set version is 1

NOTE: it won't copy content history

Returns:

a copy instance

Since:

5.10