com.atlassian.confluence.plugin.descriptor.web.model
Class ConfluenceWebLink

java.lang.Object
  com.atlassian.confluence.plugin.descriptor.web.model.ConfluenceWebLink

All Implemented Interfaces:

SettableWebLink, WebLink

public class ConfluenceWebLink
extends Object
implements SettableWebLink

A confluence specific wrapper for the WebLink

Constructor Summary

ConfluenceWebLink()

ConfluenceWebLink(WebLink webLink)

Method Summary

String	getAccessKey(GlobalHelper helper)
String	getAccessKey(Map params)
WebFragmentModuleDescriptor	getDescriptor()
String	getDisplayableUrl(HttpServletRequest req, GlobalHelper helper) Deprecated. since 2.8 use getDisplayableUrl(HttpServletRequest, WebInterfaceContext)
String	getDisplayableUrl(HttpServletRequest req, Map params)
String	getDisplayableUrl(HttpServletRequest req, WebInterfaceContext context) Renders this web link in the given context.
String	getId()
String	getRenderedUrl(Map params)
String	getRenderedUrl(ThemeHelper helper) Deprecated. since 2.8 use getRenderedUrl(WebInterfaceContext)
String	getRenderedUrl(WebInterfaceContext context) Renders this web link in the given context.
boolean	hasAccessKey()
void	setLink(WebLink webLink) Provides a method to pass a WebLink.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceWebLink

public ConfluenceWebLink()

ConfluenceWebLink

public ConfluenceWebLink(WebLink webLink)

Method Detail

getRenderedUrl

@Deprecated
public String getRenderedUrl(ThemeHelper helper)

Deprecated. since 2.8 use getRenderedUrl(WebInterfaceContext)

Deprecation note: This method is deprecated from 2.8. Changing to use the new method will require modification of your URL templates slightly. Replace $helper.page with just $page, for example.

getRenderedUrl

public String getRenderedUrl(WebInterfaceContext context)

Renders this web link in the given context. The context path is not prepended, unlike getDisplayableUrl(HttpServletRequest, WebInterfaceContext). You probably want to use that method instead.

The Velocity context is not exactly the same as in the method it replaced. For example, rather than using $helper.page in your URL template, you should use just $page.

Parameters:

context - how the link is being rendered, includes relevant Confluence content and perhaps custom parameters

Returns:

a URL relative to the context path, generated from running Velocity against this link's URL parameter

getRenderedUrl

public String getRenderedUrl(Map params)

Specified by:

getRenderedUrl in interface WebLink

getDisplayableUrl

public String getDisplayableUrl(HttpServletRequest req,
                                WebInterfaceContext context)

Renders this web link in the given context. Calls WebFragmentHelper.renderVelocityFragment(String, Map) with the URL of the web link and the result of WebInterfaceContext.toMap() on the provided context. The HTTP request is used to prepend the context path.

The Velocity context is not exactly the same as the method it replaced. For example, rather than using $helper.page in your URL template, you should use just $page.

Parameters:

req - the current request, used for HttpServletRequest.getContextPath()

context - how the link is being rendered, includes relevant Confluence content and perhaps custom parameters

Returns:

a URL relative to the server's hostname generated from running Velocity against this link's URL parameter

getDisplayableUrl

@Deprecated
public String getDisplayableUrl(HttpServletRequest req,
                                           GlobalHelper helper)

Deprecated. since 2.8 use getDisplayableUrl(HttpServletRequest, WebInterfaceContext)

Deprecation note: This method is deprecated from 2.8. Changing to use the new method will require modification of your URL templates slightly. Replace $helper.page with just $page, for example.

getDisplayableUrl

public String getDisplayableUrl(HttpServletRequest req,
                                Map params)

Specified by:

getDisplayableUrl in interface WebLink

getDescriptor

public WebFragmentModuleDescriptor getDescriptor()

Specified by:

getDescriptor in interface WebLink

hasAccessKey

public boolean hasAccessKey()

Specified by:

hasAccessKey in interface WebLink

getAccessKey

public String getAccessKey(GlobalHelper helper)

getAccessKey

public String getAccessKey(Map params)

Specified by:

getAccessKey in interface WebLink

getId

public String getId()

Specified by:

getId in interface WebLink

setLink

public void setLink(WebLink webLink)

Description copied from interface: SettableWebLink

Provides a method to pass a WebLink.

Specified by:

setLink in interface SettableWebLink

Parameters:

webLink - the link for this WebLink