com.atlassian.confluence.links

Interface RelatedContentRefactorer

All Known Implementing Classes:

DefaultRelatedContentRefactorer

public interface RelatedContentRefactorer

Method Summary

Modifier and Type	Method and Description
void	contractAbsoluteReferencesInContent(List<Page> movedPageList)
void	contractAbsoluteReferencesInContent(List<Page> movedPageList, Space previousSpace) Deprecated. since 5.9 use contractAbsoluteReferencesInContent(List movedPageList) instead
String	refactorReferencesToBeRelative(SpaceContentEntityObject content) Update any references to the content itself (such as attachment links or embedded images) or to content in the same space.
void	updateReferences(SpaceContentEntityObject content, Space previousSpace, String previousTitle) Update all the references in the supplied content when the content has moved or renamed from 'previousSpace' and/or had it's title changed from 'previousTitle'.
void	updateReferencesForMovingPage(SpaceContentEntityObject content, Space previousSpace, String previousTitle) Update all the references in the supplied content when the content has moved from 'previousSpace' and/or had it's title changed from 'previousTitle'.
void	updateReferrers(Attachment attachment, Attachment previousAttachment) Iterate through all the content that links to (or embeds) the supplied attachment (prior to it's update) and update the details of this relationship to reflect the current name and owner of the attachment.
void	updateReferrers(SpaceContentEntityObject referee, Space previousSpace, String previousTitle) Iterate through all the content that currently links to 'referee' and renames all the links, saving the changed content as it goes.
void	updateReferrersForMovingPage(SpaceContentEntityObject referee, Space previousSpace, String previousTitle, List<Page> movedPageList) Iterate through all the content that currently links to 'referee' and renames all the links, saving the changed content as it goes.

Method Detail

updateReferrers

void updateReferrers(SpaceContentEntityObject referee,
                     Space previousSpace,
                     String previousTitle)

Iterate through all the content that currently links to 'referee' and renames all the links, saving the changed content as it goes. You should note that the referee itself won't be updated even if it does include references to itself. Instead you should use updateReferences(SpaceContentEntityObject, Space, String).

This rename will be recorded in the content's history

Note: The change of reference assumes that the content referred to has not changed type. It has simply changed space and/or title. For example, there is currently no way of refactoring a reference to blog post to become a reference to a page.

Parameters:

referee - the content we want to update references to, with it's new attributes already saved (e.g. new title, or new space)

previousSpace - the space that the content was in previous to the update (this may be the current space for the content)

previousTitle - the title of the content prior to it being updated (may be the same as the current title)

updateReferrersForMovingPage

void updateReferrersForMovingPage(SpaceContentEntityObject referee,
                                  Space previousSpace,
                                  String previousTitle,
                                  List<Page> movedPageList)

Iterate through all the content that currently links to 'referee' and renames all the links, saving the changed content as it goes. You should note that the referee itself won't be updated even if it does include references to itself. Instead you should use updateReferences(SpaceContentEntityObject, Space, String).

This rename will be recorded in the content's history

Note: The change of reference assumes that the content referred to has not changed type. It has simply changed space and/or title. For example, there is currently no way of refactoring a reference to blog post to become a reference to a page.

Parameters:

referee - the content we want to update references to, with it's new attributes already saved (e.g. new title, or new space)

previousSpace - the space that the content was in previous to the update (this may be the current space for the content)

previousTitle - the title of the content prior to it being updated (may be the same as the current title)

movedPageList - list of all moved pages, used to check if referee is moved or not

updateReferrers

void updateReferrers(Attachment attachment,
                     Attachment previousAttachment)

Iterate through all the content that links to (or embeds) the supplied attachment (prior to it's update) and update the details of this relationship to reflect the current name and owner of the attachment. All modified referring content will be saved.

Parameters:

attachment - the attachment after it's update (reflecting it's new name and ownership)

previousAttachment - the attachment prior to it's update (with the old containing ContentEntityObject, etc).

updateReferences

void updateReferences(SpaceContentEntityObject content,
                      Space previousSpace,
                      String previousTitle)

Update all the references in the supplied content when the content has moved or renamed from 'previousSpace' and/or had it's title changed from 'previousTitle'. The updated SpaceContentEntityObject will be saved.

A typical usage of this would be to fix the relative and self references in a SpaceContentEntityObject that has been moved from one space to another or had it's titled changed.

Note: The change of reference assumes that the supplied content has not changed type. It has simply changed space and/or title. For example, there is currently no way of refactoring a reference to page to become a reference to a blog post.

Parameters:

content - the content to be updated

previousSpace - the space to update relative links to refer to (the space the content was previously in)

previousTitle - the title of the content prior to it being updated (may be the same as the current title)

updateReferencesForMovingPage

void updateReferencesForMovingPage(SpaceContentEntityObject content,
                                   Space previousSpace,
                                   String previousTitle)

Update all the references in the supplied content when the content has moved from 'previousSpace' and/or had it's title changed from 'previousTitle'. The updated SpaceContentEntityObject will be saved.

A typical usage of this would be to fix the relative and self references in a SpaceContentEntityObject that has been moved from one space to another or had it's titled changed.

Note: The change of reference assumes that the supplied content has not changed type. It has simply changed space and/or title. For example, there is currently no way of refactoring a reference to page to become a reference to a blog post.

Parameters:

content - the content to be updated

previousSpace - the space to update relative links to refer to (the space the content was previously in)

previousTitle - the title of the content prior to it being updated (may be the same as the current title)

refactorReferencesToBeRelative

String refactorReferencesToBeRelative(SpaceContentEntityObject content)

Update any references to the content itself (such as attachment links or embedded images) or to content in the same space. These references will be converted to be relative references.

Parameters:

content - the content to be refactored

Returns:

a refactored version of the body of the supplied content.

contractAbsoluteReferencesInContent

@Deprecated
void contractAbsoluteReferencesInContent(List<Page> movedPageList,
                                                     Space previousSpace)

Deprecated. since 5.9 use contractAbsoluteReferencesInContent(List movedPageList) instead

Update all absolute links in moved page's referencing pages to relative links

Parameters:

movedPageList - list of all moved pages

previousSpace -

contractAbsoluteReferencesInContent

void contractAbsoluteReferencesInContent(List<Page> movedPageList)