org.randombits.support.confluence

Class DefaultLinkAssistant

java.lang.Object

org.randombits.support.confluence.DefaultLinkAssistant

All Implemented Interfaces:

LinkAssistant

public final class DefaultLinkAssistant
extends java.lang.Object
implements LinkAssistant

Default implementation of the LinkAssistant.

Author:

David Peterson

Constructor Summary

Constructors

Constructor and Description

DefaultLinkAssistant(com.atlassian.confluence.security.PermissionManager permissionManager, com.atlassian.confluence.core.ContextPathHolder contextPathHolder, org.randombits.support.core.env.EnvironmentAssistant environmentAssistant, com.atlassian.confluence.links.LinkManager linkManager, com.atlassian.confluence.pages.PageManager pageManager, com.atlassian.confluence.pages.AttachmentManager attachmentManager)

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultLinkAssistant

public DefaultLinkAssistant(com.atlassian.confluence.security.PermissionManager permissionManager,
                    com.atlassian.confluence.core.ContextPathHolder contextPathHolder,
                    org.randombits.support.core.env.EnvironmentAssistant environmentAssistant,
                    com.atlassian.confluence.links.LinkManager linkManager,
                    com.atlassian.confluence.pages.PageManager pageManager,
                    com.atlassian.confluence.pages.AttachmentManager attachmentManager)

Method Detail

getURLForWikiLink

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

Specified by:

getURLForWikiLink in interface LinkAssistant

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface LinkAssistant

saveOutgoingLink

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

Specified by:

saveOutgoingLink in interface LinkAssistant

saveOutgoingLink

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

Specified by:

saveOutgoingLink in interface LinkAssistant

saveOutgoingLink

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

Specified by:

saveOutgoingLink in interface LinkAssistant

getURLForEntity

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

Specified by:

getURLForEntity in interface LinkAssistant

getURLForEntity

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

Specified by:

getURLForEntity in interface LinkAssistant

getEntityForWikiLink

public 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.

Specified by:

getEntityForWikiLink in interface LinkAssistant

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

public 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'.

Specified by:

getWikiLinkForEntity in interface LinkAssistant

Parameters:

context - The context being linked from.

entity - The entity to link to.

Returns:

The wiki link text.