com.atlassian.gadgets.dashboard.internal
Interface DashboardUrlBuilder

All Superinterfaces:

UrlBuilder

All Known Implementing Classes:

DashboardUrlBuilderImpl

public interface DashboardUrlBuilder
extends UrlBuilder

Builds URLs to resources in the dashboard-plugin.

Method Summary

String	buildDashboardDiagnosticsRelativeUrl() Returns a relative URL that can be used to access the Dashboard Diagnostics Servlet.
String	buildDashboardDirectoryBaseUrl() Returns the base URL of the directory
String	buildDashboardDirectoryResourceUrl() Returns a URL that can be used to retrieve the list of available gadgets in the directory or to post a new gadget spec URL to the directory.
String	buildDashboardDirectoryUrl(DashboardId dashboardId) Returns a URL that can be used to post a new gadget to the directory.
String	buildDashboardLayoutUrl(DashboardId dashboardId) Returns the URL to the layout resource of a dashboard.
String	buildDashboardResourceUrl(DashboardId dashboardId) Returns a URL that can be used to access the Dashboard resource, to post new gadgets.
String	buildDashboardUrl(DashboardId dashboardId) Returns the URL to the dashboard container.
String	buildErrorGadgetUrl() Returns a URL that can be used to display an error message when there is a problem loading a gadget.
String	buildGadgetColorUrl(DashboardId dashboardId, GadgetId gadgetId) Returns the URL to the color resource of a gadget.
String	buildGadgetUrl(DashboardId dashboardId, GadgetId gadgetId) Returns the URL to a gadget resource on a dashboard.
String	buildGadgetUserPrefsUrl(DashboardId dashboardId, GadgetId gadgetId) Returns the URL to the user prefs resource of a gadget.
String	buildRpcJsUrl() Returns the URL to the RPC javascript file for the dashboard container.
String	buildSecurityTokensUrl() Returns the URL for getting new security tokens.

Methods inherited from interface com.atlassian.gadgets.util.UrlBuilder

buildImageUrl

Method Detail

buildDashboardUrl

String buildDashboardUrl(DashboardId dashboardId)

Returns the URL to the dashboard container.

Parameters:

dashboardId - the dashboard ID to return the URL for

Returns:

the URL to the dashboard container.

buildRpcJsUrl

String buildRpcJsUrl()

Returns the URL to the RPC javascript file for the dashboard container.

Specified by:

buildRpcJsUrl in interface UrlBuilder

Returns:

the URL to the RPC javascript file for the dashboard container.

buildDashboardLayoutUrl

String buildDashboardLayoutUrl(DashboardId dashboardId)

Returns the URL to the layout resource of a dashboard.

Parameters:

dashboardId - DashboardId of the dashboard that we want the layout resource URL of

Returns:

the URL to the layout resource of the dashboard

buildGadgetUrl

String buildGadgetUrl(DashboardId dashboardId,
                      GadgetId gadgetId)

Returns the URL to a gadget resource on a dashboard.

Parameters:

dashboardId - DashboardId to find the GadgetId on

gadgetId - GadgetId of the gadget we want the resource URL of

Returns:

the URL to a gadget resource on a dashboard

buildGadgetColorUrl

String buildGadgetColorUrl(DashboardId dashboardId,
                           GadgetId gadgetId)

Returns the URL to the color resource of a gadget.

Parameters:

dashboardId - DashboardId to find the GadgetId on

gadgetId - GadgetId of the gadget we want the color resource URL of

Returns:

the URL to the color resource of a gadget

buildGadgetUserPrefsUrl

String buildGadgetUserPrefsUrl(DashboardId dashboardId,
                               GadgetId gadgetId)

Returns the URL to the user prefs resource of a gadget.

Parameters:

dashboardId - DashboardId to find the GadgetId on

gadgetId - GadgetId of the gadget we want the user prefs resource URL of

Returns:

the URL to the user prefs resource of a gadget

buildErrorGadgetUrl

String buildErrorGadgetUrl()

Returns a URL that can be used to display an error message when there is a problem loading a gadget.

Returns:

URL that can be used to display an error message when there is a problem loading a gadget.

buildDashboardDirectoryResourceUrl

String buildDashboardDirectoryResourceUrl()

Returns a URL that can be used to retrieve the list of available gadgets in the directory or to post a new gadget spec URL to the directory.

Returns:

URL that can be used to retrieve the list of available gadgets in the directory or to post a new gadget spec URL to the directory.

buildDashboardResourceUrl

String buildDashboardResourceUrl(DashboardId dashboardId)

Returns a URL that can be used to access the Dashboard resource, to post new gadgets.

Parameters:

dashboardId - the ID of the dashboard to post gadgets to

Returns:

URL that can be used to access the Dashboard resource, to post new gadgets.

buildDashboardDirectoryUrl

String buildDashboardDirectoryUrl(DashboardId dashboardId)

Returns a URL that can be used to post a new gadget to the directory.

Parameters:

dashboardId - the ID of the dashboard to post gadgets to

Returns:

URL that can be used to post a new gadget to the directory.

buildDashboardDirectoryBaseUrl

String buildDashboardDirectoryBaseUrl()

Returns the base URL of the directory

Returns:

the base URL of the directory

buildDashboardDiagnosticsRelativeUrl

String buildDashboardDiagnosticsRelativeUrl()

Returns a relative URL that can be used to access the Dashboard Diagnostics Servlet.

Returns:

relative URL that can be used to access the Dashboard Diagnostics Servlet.

buildSecurityTokensUrl

String buildSecurityTokensUrl()

Returns the URL for getting new security tokens.

Returns:

URL for getting new security tokens.