com.atlassian.confluence.links

Interface LinkManager

All Known Implementing Classes:

DefaultLinkManager

public interface LinkManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	CAMELCASE_LINK_PATTERN
static String	NORMAL_LINK_PATTERN

Method Summary

Modifier and Type	Method and Description
Stream<OutgoingLinkMeta>	countIncomingLinksForContents(SpaceContentEntityObject rootPage, SpaceContentEntityObject parentPage) Helping method to get all incoming links of multiple contents at once.
int	countPagesWithIncomingLinks(SpaceContentEntityObject rootPage) Get the number of pages in a page hierarchy that have incoming links.
List	extractLinksFromContent(ContentEntityObject content) Deprecated. since 4.0. See {com.atlassian.confluence.content.render.xhtml.links.OutgoingLinksExtractor}
String	getContentWithRenamedLinks(ContentEntityObject referringContent, SpaceContentEntityObject pageBeingRenamed, String newSpaceKey, String newPageTitle) Deprecated. since 4.0. See RelatedContentRefactorer.updateReferrers(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)
List	getIncomingLinksToContent(ContentEntityObject content)
Collection<ContentEntityObject>	getReferringContent(ContentEntityObject content)
Collection<ContentEntityObject>	getReferringContent(String spaceKey, List<ContentEntityObject> collection) Gets collection of referring content with given set of pages within single space
String	getSelfContentWithRenamedLinks(ContentEntityObject referringContent, String newSpaceKey) Deprecated. since 4.0. See RelatedContentRefactorer.updateReferences(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)
void	removeCorruptOutgoingLinks()
void	removeLink(OutgoingLink link) Remove an internal link
void	renameOutgoingLinksToAttachments(ContentEntityObject refContent, String existingFileName, String newFileName) Deprecated. since 4.0. See RelatedContentRefactorer.updateReferences(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)
void	renameOutgoingLinksToMovedAttachments(ContentEntityObject refContent, String existingFileName, String newFileName, ContentEntityObject srcContent, ContentEntityObject destContent) Deprecated. since 4.0. See RelatedContentRefactorer#updateReferrers(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.spaces.Space, String, String)
void	saveLink(OutgoingLink link) Save an internal link
void	updateOutgoingLinks(ContentEntityObject content)

Field Detail

CAMELCASE_LINK_PATTERN

static final String CAMELCASE_LINK_PATTERN

See Also:

Constant Field Values

NORMAL_LINK_PATTERN

static final String NORMAL_LINK_PATTERN

See Also:

Constant Field Values

Method Detail

saveLink

void saveLink(OutgoingLink link)

Save an internal link

removeLink

void removeLink(OutgoingLink link)

Remove an internal link

getSelfContentWithRenamedLinks

@Deprecated
String getSelfContentWithRenamedLinks(ContentEntityObject referringContent,
                                                  String newSpaceKey)

Deprecated. since 4.0. See RelatedContentRefactorer.updateReferences(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)

extracts the text from the page to be moved, renames links which target the old space and returns the content with the updated links

getIncomingLinksToContent

List getIncomingLinksToContent(ContentEntityObject content)

getContentWithRenamedLinks

@Deprecated
String getContentWithRenamedLinks(ContentEntityObject referringContent,
                                              SpaceContentEntityObject pageBeingRenamed,
                                              String newSpaceKey,
                                              String newPageTitle)

Deprecated. since 4.0. See RelatedContentRefactorer.updateReferrers(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)

extracts the text from the referring page, renames links with newSpaceKey and newPageTitle and returns the content with updated links

Parameters:

referringContent - page that contains a link to the pageBeingRenamed

pageBeingRenamed - page that is being renamed or moved

newSpaceKey - the new space key of 'pageBeingRenamed'

newPageTitle - the new title for 'pageBeingRenamed'

countIncomingLinksForContents

Stream<OutgoingLinkMeta> countIncomingLinksForContents(SpaceContentEntityObject rootPage,
                                                       SpaceContentEntityObject parentPage)

Helping method to get all incoming links of multiple contents at once.

Parameters:

rootPage -

parentPage -

Returns:

Stream of OutgoingLinkMeta

Since:

6.0

countPagesWithIncomingLinks

int countPagesWithIncomingLinks(SpaceContentEntityObject rootPage)

Get the number of pages in a page hierarchy that have incoming links. Note that this excludes links within the hierarchy.

Parameters:

rootPage - the root page of the hierarchy. Links to this page are also counted.

Returns:

The number of pages in the hierarchy that have incoming links, excluding links within the hierarchy.

Since:

6.0

renameOutgoingLinksToAttachments

@Deprecated
void renameOutgoingLinksToAttachments(ContentEntityObject refContent,
                                                  String existingFileName,
                                                  String newFileName)

Deprecated. since 4.0. See RelatedContentRefactorer.updateReferences(SpaceContentEntityObject, com.atlassian.confluence.spaces.Space, String)

Renames all attachments links on the current page (srcContent) Used for simple renaming of attachments

renameOutgoingLinksToMovedAttachments

@Deprecated
void renameOutgoingLinksToMovedAttachments(ContentEntityObject refContent,
                                                       String existingFileName,
                                                       String newFileName,
                                                       ContentEntityObject srcContent,
                                                       ContentEntityObject destContent)
                                                throws LinksUpdateException

Deprecated. since 4.0. See RelatedContentRefactorer#updateReferrers(com.atlassian.confluence.pages.Attachment, com.atlassian.confluence.spaces.Space, String, String)

Renames all attachment links on the current page. This function has to be used when the attachment is moved.

Throws:

LinksUpdateException

updateOutgoingLinks

void updateOutgoingLinks(ContentEntityObject content)

extractLinksFromContent

@Deprecated
List extractLinksFromContent(ContentEntityObject content)

Deprecated. since 4.0. See {com.atlassian.confluence.content.render.xhtml.links.OutgoingLinksExtractor}

Parameters:

content -

Returns:

getReferringContent

Collection<ContentEntityObject> getReferringContent(ContentEntityObject content)

getReferringContent

Collection<ContentEntityObject> getReferringContent(String spaceKey,
                                                    List<ContentEntityObject> collection)

Gets collection of referring content with given set of pages within single space

Since:

5.8.15

removeCorruptOutgoingLinks

void removeCorruptOutgoingLinks()