org.randombits.support.confluence

Interface LinkAssistant

All Known Implementing Classes:

DefaultLinkAssistant

public interface LinkAssistant

Author:

David Peterson

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContextPath()
com.atlassian.confluence.core.ConfluenceEntityObject	getEntityForWikiLink(com.atlassian.confluence.content.render.xhtml.ConversionContext context, java.lang.String linkText) Parses a content name (e.g.
java.lang.String	getURLForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context, com.atlassian.confluence.core.ConfluenceEntityObject ceo)
java.lang.String	getURLForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context, com.atlassian.confluence.core.ConfluenceEntityObject ceo, java.lang.String anchor)
java.lang.String	getURLForWikiLink(com.atlassian.confluence.content.render.xhtml.ConversionContext context, java.lang.String linkText)
java.lang.String	getWikiLinkForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context, com.atlassian.confluence.core.ConfluenceEntityObject entity) Generates a wiki link, without any surrounding '[]'s.
boolean	saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent, com.atlassian.confluence.core.ConfluenceEntityObject targetContent)
boolean	saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent, java.lang.String url)
boolean	saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent, java.lang.String spaceKey, java.lang.String targetPageTitle)

Method Detail

getEntityForWikiLink

com.atlassian.confluence.core.ConfluenceEntityObject getEntityForWikiLink(com.atlassian.confluence.content.render.xhtml.ConversionContext context,
                                                                        java.lang.String linkText)

Parses a content name (e.g. 'SPACE:Page' or 'Page^attachment.ext') and returns the entity it identifies.

Parameters:

context - The context to get spaces/content id info from if not specified in the contentName.

linkText - The name of the entity being tracked

Returns:

The entity matching the name, or null if it could not be found.

getWikiLinkForEntity

java.lang.String getWikiLinkForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context,
                                    com.atlassian.confluence.core.ConfluenceEntityObject entity)

Generates a wiki link, without any surrounding '[]'s. Eg 'My Page^attachment.ext'.

Parameters:

context -

entity - The entity to link to.

Returns:

The wiki link text.

getURLForEntity

java.lang.String getURLForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context,
                               com.atlassian.confluence.core.ConfluenceEntityObject ceo)

getURLForEntity

java.lang.String getURLForEntity(com.atlassian.confluence.content.render.xhtml.ConversionContext context,
                               com.atlassian.confluence.core.ConfluenceEntityObject ceo,
                               java.lang.String anchor)

getURLForWikiLink

java.lang.String getURLForWikiLink(com.atlassian.confluence.content.render.xhtml.ConversionContext context,
                                 java.lang.String linkText)

getContextPath

java.lang.String getContextPath()

saveOutgoingLink

boolean saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent,
                       com.atlassian.confluence.core.ConfluenceEntityObject targetContent)

saveOutgoingLink

boolean saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent,
                       java.lang.String spaceKey,
                       java.lang.String targetPageTitle)

saveOutgoingLink

boolean saveOutgoingLink(com.atlassian.confluence.core.ContentEntityObject sourceContent,
                       java.lang.String url)