Package com.atlassian.confluence.spaces

Class ReadOnlySpaceDescription

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.AnnotatedEntityObject

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.spaces.SpaceDescription

com.atlassian.confluence.spaces.ReadOnlySpaceDescription

All Implemented Interfaces:

Searchable, Content, Addressable, ContentTypeAware, Versioned, RelatableEntity, EditableLabelable, Labelable, Spaced, Serializable, Cloneable, Comparable<ContentEntityObject>

public class ReadOnlySpaceDescription
extends SpaceDescription

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.spaces.SpaceDescription

CONTENT_TYPE_PERSONAL_SPACEDESC, CONTENT_TYPE_SPACEDESC

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, DELETED_BY, DELETED_BY_ANON_VALUE, 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	Description
ReadOnlySpaceDescription(SpaceDescription delegate)

Method Summary

Modifier and Type	Method	Description
void	addAttachment(Attachment attachment)
void	addComment(Comment comment)
void	addCustomContent(CustomContentEntityObject customContentEntityObject)
void	addLabelling(Labelling content)
void	addOutgoingLink(OutgoingLink link)
void	addPermission(ContentPermission permission)	Adds a ContentPermission.
void	applyChildVersioningPolicy(@Nullable Versioned versionToPromote, Consumer<? super Versioned> dao)	If Versioned.getVersionChildPolicy(com.atlassian.confluence.api.model.content.ContentType) specifies so, moves content from versionToPromote to this Versioned instance or makes no change.
Object	clone()
void	convertToHistoricalVersion()	Remove all data from the object that does not need to be saved by historical versions.
boolean	equals(Object o)
Attachment	getAttachmentNamed(String fileName)
List<Attachment>	getAttachments()	Don't use it directly, use AttachmentManager.getAttachments(page) instead.
String	getAttachmentsUrlPath()
String	getAttachmentUrlPath(Attachment attachment)	Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments).
String	getBodyAsString()	Convenience method that returns the String representation of the content.
String	getBodyAsStringWithoutMarkup()
BodyContent	getBodyContent()	Gets the BodyContent object for this ContentEntityObject.
BodyContent	getBodyContent(BodyType expectedBodyType)	Gets the BodyContent object for this ContentEntityObject or throws an UnsupportedOperationException if its body type is not the same as the supplied expectedBodyType.
List<BodyContent>	getBodyContents()
String	getCollaborativeEditingUuid()
List<Comment>	getComments()
ContentId	getContentId()	Returns the ContentId for this entity object, if it implements ContentConvertible.
ContentPermission	getContentPermission(String permissionType)	Gives back the first content permission of a specific type.
ContentPermissionSet	getContentPermissionSet(String type)	Note, this method does not return ContentPermissions inherited from the Content's ancestry.
String	getContentStatus()	Get the hibernate field for content status, distinguishing only draft/deleted/current status.
ContentStatus	getContentStatusObject()	Get the api layer enum for content status, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED.
Date	getCreationDate()
ConfluenceUser	getCreator()
String	getCreatorName()
Date	getCurrentDate()
List<CustomContentEntityObject>	getCustomContent()
BodyType	getDefaultBodyType()
String	getDisplayTitle()	Returns the display title.
ContentEntityObject	getEntity()	Gets the ContentEntityObject that backs this piece of content.
String	getExcerpt()
List<Label>	getGlobalLabels(com.atlassian.user.User user)	List the labels on this content that are global labels
long	getId()
String	getIdAsString()
int	getLabelCount()	Get the number of labels that are associated with this object.
List<Labelling>	getLabellings()
List<Label>	getLabels()	Retrieve the labels that are associated with this object.
List<Label>	getLabelsForDisplay(com.atlassian.user.User user)	List the labels on this content that are visible to a particular user, and should be shown in a list of labels.
Date	getLastModificationDate()
ConfluenceUser	getLastModifier()
String	getLastModifierName()
ContentEntityObject	getLatestVersion()	Get the latest, current version of this versioned object.
long	getLatestVersionId()
List<Attachment>	getLatestVersionsOfAttachments()
String	getLowerTitle()
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.
Long	getOriginalVersionId()
List<OutgoingLink>	getOutgoingLinks()	An outgoing link is a link on this page to another confluence page. It could also link to a website URL These links are contained in the page content They are refreshed each time the page is updated (LinkManager.updateOutgoingLinks())
List<ContentPermission>	getPermissions()	Get all the permissions that apply to this content.
List<Label>	getPersonalLabels(com.atlassian.user.User user)	List the labels on this content that are personal labels for a particular user
ContentProperties	getProperties()
String	getRenderedVersionComment()
Collection<Searchable>	getSearchableDependants()	When we un-index something (say, a page), we also need to un-index everything contained within that page (comments, attachments), because presumably they're all about to go away.
ContentSelector	getSelector()
String	getShareId()
Space	getSpace()
String	getSpaceKey()
String	getSynchronyRevision()
String	getSynchronyRevisionSource()
List<Label>	getTeamLabels(com.atlassian.user.User user)	List the labels on this content that are team labels for a particular user
String	getTitle()
Optional<Instant>	getTrashDate()	Get trash date if this CEO has been added to the trash since Confluence 7.14.
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.
ContentTypeEnum	getTypeEnum()
String	getUrlPath()
int	getVersion()	Return the version number of this version of the object.
VersionChildOwnerPolicy	getVersionChildPolicy(ContentType contentType)	Returns the right VersionChildOwnerPolicy depending on the passed contentType.
String	getVersionComment()
List<Label>	getVisibleLabels(com.atlassian.user.User user)	List the labels on this content that are visible to a particular user
boolean	hasContentPermissions()
int	hashCode()
boolean	hasPermissions(String type)
boolean	isCurrent()	Does this content have "current" status? (non-trashed and non-draft)
boolean	isDeleted()
boolean	isDraft()
boolean	isFavourite(ConfluenceUser user)	Is this object marked as somebody's favourite?
boolean	isIndexable()	pages, blogs etc that aren't not associated with a space (either because they are historical or corrupt) should not be indexed if they are indexed, and returned in search results, they are broken and are therefore useless
boolean	isInSpace(Space space)
boolean	isLatestVersion()
boolean	isNew()	Is this the first version of this object?
boolean	isPersistent()	This object is persistent if the id is not 0.
boolean	isPersonalSpace()
boolean	isUnpublished()
boolean	isVersionCommentAvailable()
void	removeAttachment(Attachment attachment)
void	removeComment(Comment comment)
void	removeContentPermissionSet(ContentPermissionSet set)	This method removes the given ContentPermissionSet from this CEO and disconnects the set from its owner.
void	removeCustomContent(CustomContentEntityObject customContentEntityObject)
void	removeLabelling(Labelling labelling)
void	removeOutgoingLink(OutgoingLink link)
void	restore()	restores content from the trash
void	setAttachments(List<Attachment> attachments)
void	setBodyAsString(String content)	Convenience method that sets the content of this ContentEntityObject.
void	setBodyContent(BodyContent bodyContent)	Sets the BodyContent object for this ContentEntityObject.
void	setBodyContents(List<BodyContent> bodyContents)
void	setClock(com.atlassian.core.util.Clock clock)
void	setCollaborativeEditingUuid(String uuid)
void	setComments(List<Comment> comments)
void	setContentPropertiesFrom(ContentEntityObject ceo)	Initialises the ContentProperties of this ContentEntityObject by performing a deep clone of the ContentEntityObject object's properties.
void	setContentStatus(String contentStatus)	Set the hibernate field for content status, distinguishing only draft/deleted/current status.
void	setCreationDate(Date creationDate)
void	setCreator(ConfluenceUser creator)
void	setCreatorName(String creatorName)	Set the username of the creator
void	setId(long id)
void	setLastModificationDate(Date lastModificationDate)
void	setLastModifier(ConfluenceUser lastModifier)
void	setLastModifierName(String lastModifierName)
void	setOriginalVersion(Versioned originalVersion)	Set the current version of this object.
void	setOutgoingLinks(List<OutgoingLink> outgoingLinks)
void	setShareId(String shareId)
void	setSpace(Space space)
void	setSynchronyRevision(String synchronyRevision)
void	setSynchronyRevisionSource(String synchronyRevisionSource)
void	setTitle(String title)
void	setVersion(int version)	Set the version number of this version of the object.
void	setVersionComment(String versionComment)
boolean	sharedAccessAllowed(com.atlassian.user.User user)	Checks if this draft can be accessed by users other than the creator (shared access)
boolean	sharedAccessAllowed(String shareId)	Checks if this draft can be accessed by users other than the creator (shared access)
String	toString()
void	trash()	places content in trash can
boolean	wasCreatedBy(com.atlassian.user.User user)

Methods inherited from class com.atlassian.confluence.spaces.SpaceDescription

getPermissionLastModifiedDate, setPermissionLastModifiedDate

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

compareTo, ensureAttachmentBelongsToContent, getAttachmentManager, getContainerContent, replaceContentProperties, restoreDependents, setContainerContent, setOriginalVersionId, toPageContext, trash, trash

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

setLabellings

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

getConfluenceRevision

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

getRealClass

Methods inherited from class java.lang.Object

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

Constructor Details

ReadOnlySpaceDescription

public ReadOnlySpaceDescription(SpaceDescription delegate)

Method Details

getLabels

public List<Label> getLabels()

Description copied from interface: Labelable

Retrieve the labels that are associated with this object.

Specified by:

getLabels in interface Labelable

Overrides:

getLabels in class AbstractLabelableEntityObject

Returns:

a list of label instances.

getLabelCount

public int getLabelCount()

Description copied from interface: Labelable

Get the number of labels that are associated with this object.

Specified by:

getLabelCount in interface Labelable

Overrides:

getLabelCount in class AbstractLabelableEntityObject

Returns:

the number of labels associated with this object.

isFavourite

public boolean isFavourite(ConfluenceUser user)

Description copied from interface: Labelable

Is this object marked as somebody's favourite?

Specified by:

isFavourite in interface Labelable

Overrides:

isFavourite in class AbstractLabelableEntityObject

Parameters:

user - the user who is being checked against. If user is null this method must always return false (anonymous users can not mark anything as a favourite, obviously)

Returns:

true if the labelable object is a 'favourite' of a given user, false otherwise

getVisibleLabels

public List<Label> getVisibleLabels(com.atlassian.user.User user)

Description copied from class: AbstractLabelableEntityObject

List the labels on this content that are visible to a particular user

Overrides:

getVisibleLabels in class AbstractLabelableEntityObject

Parameters:

user - the user

Returns:

the labels on this content visible to that user

getPersonalLabels

public List<Label> getPersonalLabels(com.atlassian.user.User user)

Description copied from class: AbstractLabelableEntityObject

List the labels on this content that are personal labels for a particular user

Overrides:

getPersonalLabels in class AbstractLabelableEntityObject

Parameters:

user - the user

Returns:

the personal labels on this content visible to the user

getGlobalLabels

public List<Label> getGlobalLabels(com.atlassian.user.User user)

Description copied from class: AbstractLabelableEntityObject

List the labels on this content that are global labels

Overrides:

getGlobalLabels in class AbstractLabelableEntityObject

Parameters:

user - the user

Returns:

the global labels on this content visible to the user

getTeamLabels

public List<Label> getTeamLabels(com.atlassian.user.User user)

Description copied from class: AbstractLabelableEntityObject

List the labels on this content that are team labels for a particular user

Overrides:

getTeamLabels in class AbstractLabelableEntityObject

Parameters:

user - the user

Returns:

the team labels on this content visible to the user

getLabelsForDisplay

public List<Label> getLabelsForDisplay(com.atlassian.user.User user)

Description copied from class: AbstractLabelableEntityObject

List the labels on this content that are visible to a particular user, and should be shown in a list of labels. This is like {code}getVisibleLabels{code} except that it also filters out special labels like favourites

Overrides:

getLabelsForDisplay in class AbstractLabelableEntityObject

Parameters:

user - the user

Returns:

the labels on this content visible to that user

getLabellings

public List<Labelling> getLabellings()

Specified by:

getLabellings in interface EditableLabelable

Overrides:

getLabellings in class AbstractLabelableEntityObject

addLabelling

public void addLabelling(Labelling content)

Specified by:

addLabelling in interface EditableLabelable

Overrides:

addLabelling in class AbstractLabelableEntityObject

removeLabelling

public void removeLabelling(Labelling labelling)

Specified by:

removeLabelling in interface EditableLabelable

Overrides:

removeLabelling in class AbstractLabelableEntityObject

getVersion

public int getVersion()

Description copied from interface: Versioned

Return the version number of this version of the object. Version numbers are integers in ascending chronological order from 1 (the first version). Clients must not assume if two versions x and y exist, that any integer versions between x and y also exist.

Specified by:

getVersion in interface Versioned

Overrides:

getVersion in class AbstractVersionedEntityObject

Returns:

the version number of this version of the object

setVersion

public void setVersion(int version)

Description copied from interface: Versioned

Set the version number of this version of the object. Only call this method if you are creating a new version.

Specified by:

setVersion in interface Versioned

Overrides:

setVersion in class AbstractVersionedEntityObject

Parameters:

version - the new version number for this version of the object.

isNew

public boolean isNew()

Description copied from interface: Versioned

Is this the first version of this object?

Specified by:

isNew in interface Versioned

Overrides:

isNew in class AbstractVersionedEntityObject

Returns:

true if this is the first version of this versioned object, false if it is a later version.

isLatestVersion

public boolean isLatestVersion()

Specified by:

isLatestVersion in interface Versioned

Overrides:

isLatestVersion in class AbstractVersionedEntityObject

Returns:

true if this is the latest (current) version of the object, false if it is an historical version.

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

getCreatorName

public String getCreatorName()

Overrides:

getCreatorName in class ConfluenceEntityObject

Returns:

username of the creator, or null if created anonymously

getCreator

public ConfluenceUser getCreator()

Overrides:

getCreator in class ConfluenceEntityObject

setCreatorName

public void setCreatorName(String creatorName)

Description copied from class: ConfluenceEntityObject

Set the username of the creator

Overrides:

setCreatorName in class ConfluenceEntityObject

getLastModifierName

public String getLastModifierName()

Overrides:

getLastModifierName in class ConfluenceEntityObject

Returns:

username of the last modifier, or null if none.

getLastModifier

public ConfluenceUser getLastModifier()

Overrides:

getLastModifier in class ConfluenceEntityObject

setLastModifierName

public void setLastModifierName(String lastModifierName)

Overrides:

setLastModifierName in class ConfluenceEntityObject

setCreator

public void setCreator(ConfluenceUser creator)

Overrides:

setCreator in class ConfluenceEntityObject

setLastModifier

public void setLastModifier(ConfluenceUser lastModifier)

Overrides:

setLastModifier in class ConfluenceEntityObject

isPersistent

public boolean isPersistent()

Description copied from class: ConfluenceEntityObject

This object is persistent if the id is not 0.

Specified by:

isPersistent in interface EditableLabelable

Overrides:

isPersistent in class ConfluenceEntityObject

Returns:

true if this instance is a persisted label.

getTypeEnum

public ContentTypeEnum getTypeEnum()

Overrides:

getTypeEnum in class ContentEntityObject

getIdAsString

public String getIdAsString()

Overrides:

getIdAsString in class ContentEntityObject

getTitle

public String getTitle()

Specified by:

getTitle in interface EditableLabelable

Overrides:

getTitle in class ContentEntityObject

setTitle

public void setTitle(String title)

Overrides:

setTitle in class ContentEntityObject

getLowerTitle

public String getLowerTitle()

Overrides:

getLowerTitle in class ContentEntityObject

getBodyContent

public BodyContent getBodyContent()

Description copied from class: ContentEntityObject

Gets the BodyContent object for this ContentEntityObject. Although it appears that there may be a number of BodyContent objects attached to a ContentEntityObject, only one is ever used. If there are none currently attached, a new BodyContent object is created and returned. Any values set on the returned BodyContent will not be saved unless a call is made to ContentEntityObject.setBodyContent(com.atlassian.confluence.core.BodyContent). Null is never returned.

This method should not normally be called directly unless, you need to be able to handle different body types. Use ContentEntityObject.getBodyAsString() as you should normally be expecting only one type.

Overrides:

getBodyContent in class ContentEntityObject

Returns:

the BodyContent.

See Also:

• ContentEntityObject.getBodyContent(BodyType)

getBodyContent

public BodyContent getBodyContent(BodyType expectedBodyType)

Description copied from class: ContentEntityObject

Gets the BodyContent object for this ContentEntityObject or throws an UnsupportedOperationException if its body type is not the same as the supplied expectedBodyType.

This method should not normally be called directly unless, you need to be able to handle different body types. Use ContentEntityObject.getBodyAsString() and ContentEntityObject.getBodyAsString() as you should normally be expecting only one type.

Overrides:

getBodyContent in class ContentEntityObject

Parameters:

expectedBodyType - that can be handled by the caller.

Returns:

the BodyContent.

See Also:

• ContentEntityObject.getBodyContent()

setBodyContent

public void setBodyContent(BodyContent bodyContent)

Description copied from class: ContentEntityObject

Sets the BodyContent object for this ContentEntityObject.

This method should not normally be called directly unless, you need to be able to handle different body types. Use ContentEntityObject.setBodyAsString(java.lang.String) as you should normally be expecting only one type.

Overrides:

setBodyContent in class ContentEntityObject

Parameters:

bodyContent - to be set. If the supplied bodyContent or its body are null, the list of body contents are cleared.

getBodyAsString

public String getBodyAsString()

Description copied from class: ContentEntityObject

Convenience method that returns the String representation of the content.

Overrides:

getBodyAsString in class ContentEntityObject

Returns:

the content.

setBodyAsString

public void setBodyAsString(String content)

Description copied from class: ContentEntityObject

Convenience method that sets the content of this ContentEntityObject.

Overrides:

setBodyAsString in class ContentEntityObject

Parameters:

content - the String representation of the content.

getBodyContents

public List<BodyContent> getBodyContents()

Overrides:

getBodyContents in class ContentEntityObject

setBodyContents

public void setBodyContents(List<BodyContent> bodyContents)

Overrides:

setBodyContents in class ContentEntityObject

getOutgoingLinks

public List<OutgoingLink> getOutgoingLinks()

Description copied from class: ContentEntityObject

An outgoing link is a link on this page to another confluence page.
It could also link to a website URL
These links are contained in the page content
They are refreshed each time the page is updated (LinkManager.updateOutgoingLinks())

Overrides:

getOutgoingLinks in class ContentEntityObject

Returns:

List of OutgoingLinks

setOutgoingLinks

public void setOutgoingLinks(List<OutgoingLink> outgoingLinks)

Overrides:

setOutgoingLinks in class ContentEntityObject

addOutgoingLink

public void addOutgoingLink(OutgoingLink link)

Overrides:

addOutgoingLink in class ContentEntityObject

removeOutgoingLink

public void removeOutgoingLink(OutgoingLink link)

Overrides:

removeOutgoingLink in class ContentEntityObject

setOriginalVersion

public void setOriginalVersion(Versioned originalVersion)

Description copied from interface: Versioned

Set the current version of this object. After this method is called, this object will become an historical version of the object passed in.

Specified by:

setOriginalVersion in interface Versioned

Overrides:

setOriginalVersion in class ContentEntityObject

Parameters:

originalVersion - the current version of this object.

applyChildVersioningPolicy

public void applyChildVersioningPolicy(@Nullable Versioned versionToPromote,
 Consumer<? super Versioned> dao)

Description copied from interface: Versioned

If Versioned.getVersionChildPolicy(com.atlassian.confluence.api.model.content.ContentType) specifies so, moves content from versionToPromote to this Versioned instance or makes no change.

Specified by:

applyChildVersioningPolicy in interface Versioned

Overrides:

applyChildVersioningPolicy in class ContentEntityObject

Parameters:

versionToPromote - the new version of the current instance that we're getting the children from

dao - onRemove used to delete dangling contained content

equals

public boolean equals(Object o)

Overrides:

equals in class ContentEntityObject

toString

public String toString()

Overrides:

toString in class ContentEntityObject

getSearchableDependants

public Collection<Searchable> getSearchableDependants()

Description copied from interface: Searchable

When we un-index something (say, a page), we also need to un-index everything contained within that page (comments, attachments), because presumably they're all about to go away.

getPermissions

public List<ContentPermission> getPermissions()

Description copied from class: ContentEntityObject

Get all the permissions that apply to this content. Please do not modify the contents of this list!

Overrides:

getPermissions in class ContentEntityObject

Returns:

a list of all the permissions that apply to this content.

getContentPermission

public ContentPermission getContentPermission(String permissionType)

Description copied from class: ContentEntityObject

Gives back the first content permission of a specific type. Returns only the permission if it is set on this object and not inherited. Returns null if no permission can't be found.

Synchronized, as otherwise it was creating timing issues during the multi-threaded re-indexing.

Overrides:

getContentPermission in class ContentEntityObject

Returns:

ContentPermission

sharedAccessAllowed

public boolean sharedAccessAllowed(String shareId)

Description copied from class: ContentEntityObject

Checks if this draft can be accessed by users other than the creator (shared access)

IMPORTANT NOTE: if shared access is disallowed it prevails over permissions (only creator has access), BUT if it is allowed normal permissions still need to be checked

Drafts for existing objects are considered automatically shared according to the permissions set, but drafts for new objects are considered private, so if a user if trying to access one of them it should be verified that is doing so with the proper share id in addition to permissions.

Overrides:

sharedAccessAllowed in class ContentEntityObject

Parameters:

shareId - Optional. Used to check for access if needed

Returns:

true if this draft can be accessed given a share id, false otherwise

See Also:

• TODO: delete this method after 6.0

getContentStatusObject

public ContentStatus getContentStatusObject()

Description copied from class: ContentEntityObject

Get the api layer enum for content status, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED.

Important: this has different semantics from the hibernate field ContentEntityObject.getContentStatus(), because it takes into account historical status, and uses different strings for some values.

Overrides:

getContentStatusObject in class ContentEntityObject

Returns:

the API ContentStatus for this content, distinguishing CURRENT/HISTORICAL/DRAFT/TRASHED

See Also:

• for the hibernate field value, different semantics

getContentStatus

public String getContentStatus()

Description copied from class: ContentEntityObject

Get the hibernate field for content status, distinguishing only draft/deleted/current status.

Important: this is not the same as the string value of the api ContentEntityObject.getContentStatusObject(), because that one takes into account historical status, and uses different strings for some values.

This method does NOT distinguish current and historical versions. Both will return "current". See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.

Overrides:

getContentStatus in class ContentEntityObject

Returns:

the hibernate field value, distinguishing only ContentEntityObject.CURRENT, ContentEntityObject.DRAFT, ContentEntityObject.DELETED.

See Also:

• for the API enum, different semantics

setContentStatus

public void setContentStatus(String contentStatus)

Description copied from class: ContentEntityObject

Set the hibernate field for content status, distinguishing only draft/deleted/current status.

Important: this is not the same as the string value of the api ContentEntityObject.getContentStatusObject(), because that one takes into account historical status, and uses different strings for some values.

This method does NOT distinguish current and historical versions. Both use "current". See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.

Overrides:

setContentStatus in class ContentEntityObject

Parameters:

contentStatus - the hibernate field value, ContentEntityObject.CURRENT, ContentEntityObject.DRAFT, ContentEntityObject.DELETED.

See Also:

• for the API enum, different semantics

isCurrent

public boolean isCurrent()

Description copied from class: ContentEntityObject

Does this content have "current" status? (non-trashed and non-draft)

This method does NOT distinguish current and historical versions. Both will return true. See AbstractVersionedEntityObject.isLatestVersion() to distinguish them.

Overrides:

isCurrent in class ContentEntityObject

Returns:

true if the content is live, i.e. not trashed and not a draft

See Also:

• AbstractVersionedEntityObject.isLatestVersion()

isDeleted

public boolean isDeleted()

Overrides:

isDeleted in class ContentEntityObject

isDraft

public boolean isDraft()

Overrides:

isDraft in class ContentEntityObject

sharedAccessAllowed

public boolean sharedAccessAllowed(com.atlassian.user.User user)

Description copied from class: ContentEntityObject

Checks if this draft can be accessed by users other than the creator (shared access)

IMPORTANT NOTE: if shared access is disallowed it prevails over permissions (only creator has access), BUT if it is allowed normal permissions still need to be checked

Drafts for existing objects are considered automatically shared according to the permissions set, but drafts that have never been published are considered private even without permissions set, so if a user if trying to access one of them it should be verified that is doing so with the proper share id in addition to permissions.

Overrides:

sharedAccessAllowed in class ContentEntityObject

Parameters:

user - User to check

Returns:

true if this draft can be accessed given a share id, false otherwise

See Also:

• ContentEntityObject.SHARE_ID
• SharedAccessInterceptor
• AbstractCreateAndEditPageAction.hasDraftPermission()

getShareId

public String getShareId()

Overrides:

getShareId in class ContentEntityObject

See Also:

• ContentEntityObject.SHARE_ID

setShareId

public void setShareId(String shareId)

Overrides:

setShareId in class ContentEntityObject

See Also:

• ContentEntityObject.SHARE_ID

getSynchronyRevision

public String getSynchronyRevision()

Overrides:

getSynchronyRevision in class ContentEntityObject

See Also:

• ContentEntityObject.SYNC_REV

setSynchronyRevision

public void setSynchronyRevision(String synchronyRevision)

Overrides:

setSynchronyRevision in class ContentEntityObject

See Also:

• ContentEntityObject.SYNC_REV

getSynchronyRevisionSource

public String getSynchronyRevisionSource()

Overrides:

getSynchronyRevisionSource in class ContentEntityObject

See Also:

• ContentEntityObject.SYNC_REV_SOURCE

getTrashDate

public Optional<Instant> getTrashDate()

Description copied from class: ContentEntityObject

Get trash date if this CEO has been added to the trash since Confluence 7.14. For generic cases, use TrashManagerInternal#findTrashDate

Overrides:

getTrashDate in class ContentEntityObject

Returns:

when this content entity was added to the trash or Optional.empty() if it was trashed before 7.14

setSynchronyRevisionSource

public void setSynchronyRevisionSource(String synchronyRevisionSource)

Overrides:

setSynchronyRevisionSource in class ContentEntityObject

See Also:

• ContentEntityObject.SYNC_REV_SOURCE

getCollaborativeEditingUuid

public String getCollaborativeEditingUuid()

Overrides:

getCollaborativeEditingUuid in class ContentEntityObject

See Also:

• ContentEntityObject.COLLABORATIVE_EDITING_UUID

setCollaborativeEditingUuid

public void setCollaborativeEditingUuid(String uuid)

Overrides:

setCollaborativeEditingUuid in class ContentEntityObject

See Also:

• ContentEntityObject.COLLABORATIVE_EDITING_UUID

isUnpublished

public boolean isUnpublished()

Overrides:

isUnpublished in class ContentEntityObject

wasCreatedBy

public boolean wasCreatedBy(com.atlassian.user.User user)

Overrides:

wasCreatedBy in class ContentEntityObject

trash

public void trash()

Description copied from class: ContentEntityObject

places content in trash can

Overrides:

trash in class ContentEntityObject

restore

public void restore()

Description copied from class: ContentEntityObject

restores content from the trash

Overrides:

restore in class ContentEntityObject

getAttachments

public List<Attachment> getAttachments()

Description copied from class: ContentEntityObject

Don't use it directly, use AttachmentManager.getAttachments(page) instead.

This also includes trashed items.

Overrides:

getAttachments in class ContentEntityObject

getLatestVersionsOfAttachments

public List<Attachment> getLatestVersionsOfAttachments()

Overrides:

getLatestVersionsOfAttachments in class ContentEntityObject

setAttachments

public void setAttachments(List<Attachment> attachments)

Overrides:

setAttachments in class ContentEntityObject

addAttachment

public void addAttachment(Attachment attachment)

Overrides:

addAttachment in class ContentEntityObject

removeAttachment

public void removeAttachment(Attachment attachment)

Overrides:

removeAttachment in class ContentEntityObject

getBodyAsStringWithoutMarkup

public String getBodyAsStringWithoutMarkup()

Overrides:

getBodyAsStringWithoutMarkup in class ContentEntityObject

getExcerpt

public String getExcerpt()

Overrides:

getExcerpt in class ContentEntityObject

getAttachmentsUrlPath

public String getAttachmentsUrlPath()

Overrides:

getAttachmentsUrlPath in class ContentEntityObject

getAttachmentNamed

public Attachment getAttachmentNamed(String fileName)

Overrides:

getAttachmentNamed in class ContentEntityObject

getVersionComment

public String getVersionComment()

Overrides:

getVersionComment in class ContentEntityObject

setVersionComment

public void setVersionComment(String versionComment)

Overrides:

setVersionComment in class ContentEntityObject

isVersionCommentAvailable

public boolean isVersionCommentAvailable()

Overrides:

isVersionCommentAvailable in class ContentEntityObject

clone

public Object clone()

Overrides:

clone in class ContentEntityObject

getRenderedVersionComment

public String getRenderedVersionComment()

Overrides:

getRenderedVersionComment in class ContentEntityObject

getContentPermissionSet

public ContentPermissionSet getContentPermissionSet(String type)

Description copied from class: ContentEntityObject

Note, this method does not return ContentPermissions inherited from the Content's ancestry.

Overrides:

getContentPermissionSet in class ContentEntityObject

Returns:

a set containing ContentPermissions of this type, or null if there are no content permissions explicitly set on this ContentEntityObject for the type.

hasPermissions

public boolean hasPermissions(String type)

Overrides:

hasPermissions in class ContentEntityObject

Returns:

true if this content entity object contains any ContentPermissions of the type specified

hasContentPermissions

public boolean hasContentPermissions()

Overrides:

hasContentPermissions in class ContentEntityObject

addPermission

public void addPermission(ContentPermission permission)

Description copied from class: ContentEntityObject

Adds a ContentPermission. Do not add them manually via ContentPermissionSet.addContentPermission(ContentPermission). If possible use ContentPermissionManager.addContentPermission(com.atlassian.confluence.security.ContentPermission, ContentEntityObject) instead. Also note that as of Confluence 2.4 although methods have been added to facilitate having multiple ContentPermissions per page, Confluence does not yet properly support them (eg users permitted by them will not see the data in their searches)

Overrides:

addPermission in class ContentEntityObject

removeContentPermissionSet

public void removeContentPermissionSet(ContentPermissionSet set)

Description copied from class: ContentEntityObject

This method removes the given ContentPermissionSet from this CEO and disconnects the set from its owner. This method should only be called by the DefaultContentPermissionManager. Note that as of Confluence 2.4 although methods have been added to facilitate having multiple ContentPermissions per page, Confluence does not yet properly support them (eg users permitted by them will not see the data in their searches)

Overrides:

removeContentPermissionSet in class ContentEntityObject

See Also:

• DefaultContentPermissionManager.removeContentPermission(com.atlassian.confluence.security.ContentPermission)

getComments

public List<Comment> getComments()

Overrides:

getComments in class ContentEntityObject

setComments

public void setComments(List<Comment> comments)

Overrides:

setComments in class ContentEntityObject

addComment

public void addComment(Comment comment)

Overrides:

addComment in class ContentEntityObject

removeComment

public void removeComment(Comment comment)

Overrides:

removeComment in class ContentEntityObject

getCustomContent

public List<CustomContentEntityObject> getCustomContent()

Overrides:

getCustomContent in class ContentEntityObject

Returns:

all custom content that is a child of this CEO.

addCustomContent

public void addCustomContent(CustomContentEntityObject customContentEntityObject)

Overrides:

addCustomContent in class ContentEntityObject

removeCustomContent

public void removeCustomContent(CustomContentEntityObject customContentEntityObject)

Overrides:

removeCustomContent in class ContentEntityObject

getEntity

public ContentEntityObject getEntity()

Description copied from interface: Content

Gets the ContentEntityObject that backs this piece of content.

Specified by:

getEntity in interface Content

Overrides:

getEntity in class ContentEntityObject

Returns:

the persistent object behind this content

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.

Overrides:

getContentId in class ContentEntityObject

Returns:

the ContentId representation of this object's id

getSelector

public ContentSelector getSelector()

Overrides:

getSelector in class ContentEntityObject

Returns:

the ContentSelector for this entity, which will always include the id of the latest version, and the version number for this version of the entity.

getProperties

public ContentProperties getProperties()

Overrides:

getProperties in class ContentEntityObject

Returns:

the content properties associated with this entity

setContentPropertiesFrom

public void setContentPropertiesFrom(ContentEntityObject ceo)

Description copied from class: ContentEntityObject

Initialises the ContentProperties of this ContentEntityObject by performing a deep clone of the ContentEntityObject object's properties.

Overrides:

setContentPropertiesFrom in class ContentEntityObject

getOriginalVersionId

public Long getOriginalVersionId()

Overrides:

getOriginalVersionId in class ContentEntityObject

getLatestVersionId

public long getLatestVersionId()

Overrides:

getLatestVersionId in class ContentEntityObject

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

Overrides:

getSpace in class SpaceContentEntityObject

setSpace

public void setSpace(Space space)

Overrides:

setSpace in class SpaceContentEntityObject

convertToHistoricalVersion

public void convertToHistoricalVersion()

Description copied from interface: Versioned

Remove all data from the object that does not need to be saved by historical versions. For versioned objects that are persisted, this includes removing associations with other persisted objects that may otherwise cause us to break the expected arity of the database relations.

When using Hibernate to persist versioned objects, take special care to null any field that might contain a Hibernate-persisted collection, as Hibernate does not allow two different persistent objects to refer to the same persisted collection at the same time.

Specified by:

convertToHistoricalVersion in interface Versioned

Overrides:

convertToHistoricalVersion in class SpaceContentEntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class SpaceContentEntityObject

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

isIndexable

public boolean isIndexable()

Description copied from class: SpaceContentEntityObject

pages, blogs etc that aren't not associated with a space (either because they are historical or corrupt) should not be indexed if they are indexed, and returned in search results, they are broken and are therefore useless

Specified by:

isIndexable in interface Searchable

Overrides:

isIndexable in class SpaceContentEntityObject

isInSpace

public boolean isInSpace(Space space)

Overrides:

isInSpace in class SpaceContentEntityObject

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 SpaceDescription

Returns:

the display title

getLatestVersion

public ContentEntityObject getLatestVersion()

Description copied from interface: Versioned

Get the latest, current version of this versioned object. If this object is the current version, return this object.

Note that drafts are a special version of a ContentEntityObject so for drafts this method should return the ContentEntityObject the drafts points to if it exists and the draft itself otherwise.

Specified by:

getLatestVersion in interface Versioned

Overrides:

getLatestVersion in class SpaceDescription

Returns:

the current version of this object.

See Also:

• ContentEntityObject.DRAFT

getUrlPath

public String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Overrides:

getUrlPath in class SpaceDescription

Returns:

a link to the home page of the associated space

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

Overrides:

getType in class SpaceDescription

Returns:

the content type

getSpaceKey

public String getSpaceKey()

Overrides:

getSpaceKey in class SpaceDescription

isPersonalSpace

public boolean isPersonalSpace()

Overrides:

isPersonalSpace in class SpaceDescription

getDefaultBodyType

public BodyType getDefaultBodyType()

Overrides:

getDefaultBodyType in class SpaceDescription

getAttachmentUrlPath

public String getAttachmentUrlPath(Attachment attachment)

Description copied from class: ContentEntityObject

Gets the path relative to Confluence's base URL to view the given attachment in the context of this content (for example, highlighted in the content's list of attachments). Generally you will want to call Attachment.getUrlPath() instead of this method: if we ever implement view pages for individual attachments, that's the method that will be changed to point to them.

The default implementation just returns the view page for this content.

Overrides:

getAttachmentUrlPath in class SpaceDescription

Parameters:

attachment - one of this content's attachments

Returns:

the path relative to the base url to view the attachment in the context of this content.

getId

public long getId()

Specified by:

getId in interface Addressable

Specified by:

getId in interface EditableLabelable

Specified by:

getId in interface Searchable

Overrides:

getId in class com.atlassian.core.bean.EntityObject

setId

public void setId(long id)

Overrides:

setId in class com.atlassian.core.bean.EntityObject

getCreationDate

public Date getCreationDate()

Overrides:

getCreationDate in class AnnotatedEntityObject

setCreationDate

public void setCreationDate(Date creationDate)

Overrides:

setCreationDate in class com.atlassian.core.bean.EntityObject

getLastModificationDate

public Date getLastModificationDate()

Overrides:

getLastModificationDate in class AnnotatedEntityObject

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Overrides:

setLastModificationDate in class com.atlassian.core.bean.EntityObject

setClock

public void setClock(com.atlassian.core.util.Clock clock)

Overrides:

setClock in class com.atlassian.core.bean.EntityObject

getCurrentDate

public Date getCurrentDate()

Overrides:

getCurrentDate in class com.atlassian.core.bean.EntityObject