public interface

LinkService

com.atlassian.fisheye.spi.services.LinkService

Class Overview

Provides links to various parts of the running Fisheye/Crucible instance

Summary

Public Methods
abstract String getAvatarAbsImgLink(HttpServletRequest req, String username, int size, boolean noCache)
Returns an absolute link to an avatar
abstract String getChangelogAbsLink(HttpServletRequest req, String repositoryName, String branchName)
Returns an absolute link to the Fisheye changelog page for a repository
abstract String getChangesetAbsLink(HttpServletRequest req, String repositoryName, String csid)
Returns an absolute link to a Fisheye changeset page
abstract String getCommiterAbsLink(HttpServletRequest req, String repositoryName, String committerName)
Returns an absolute link to a commiter's page
abstract String getDeletedAvatarAbsImgLink(HttpServletRequest req, int size)
Returns an absolute link to the placeholder avatar for a deleted user
abstract String getProjectAbsLink(HttpServletRequest req, String projectKey)
Returns an absolute link to a Crucible project
abstract String getReviewAbsLink(HttpServletRequest req, String permaId)
Returns an absolute link to a Crucible review
abstract String getStaticPathAbsLink(HttpServletRequest req)
Returns an absolute link to the path under which Fisheye/Crucible static resources are located
abstract String getUnknownAvatarAbsImgLink(HttpServletRequest req, int size)
Returns an absolute link to the placeholder avatar for unknown users
abstract String getUserAbsLink(HttpServletRequest req, String userName)
Returns an absolute link to a user's page

Public Methods

public abstract String getAvatarAbsImgLink (HttpServletRequest req, String username, int size, boolean noCache)

Returns an absolute link to an avatar

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
username the name of the user
size the size of the required image, in pixels
noCache whether a link to discourage caching should be returned
Returns
  • the link

public abstract String getChangelogAbsLink (HttpServletRequest req, String repositoryName, String branchName)

Returns an absolute link to the Fisheye changelog page for a repository

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
repositoryName the repo name
Returns
  • an absolute link to the Fisheye changelog page

public abstract String getChangesetAbsLink (HttpServletRequest req, String repositoryName, String csid)

Returns an absolute link to a Fisheye changeset page

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
repositoryName the repo name
csid the changeset id
Returns
  • an absolute link to the Fisheye changeset page

public abstract String getCommiterAbsLink (HttpServletRequest req, String repositoryName, String committerName)

Returns an absolute link to a commiter's page

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
repositoryName the name of the repository
committerName the name of the commiter
Returns
  • an absolute link to the commiter's page

public abstract String getDeletedAvatarAbsImgLink (HttpServletRequest req, int size)

Returns an absolute link to the placeholder avatar for a deleted user

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
size the size of the required image, in pixels
Returns
  • the link

public abstract String getProjectAbsLink (HttpServletRequest req, String projectKey)

Returns an absolute link to a Crucible project

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
projectKey the key to the project
Returns
  • an absolute link to the Crucible project

public abstract String getReviewAbsLink (HttpServletRequest req, String permaId)

Returns an absolute link to a Crucible review

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
permaId the review perma id
Returns
  • an absolute link to the Crucible review

public abstract String getStaticPathAbsLink (HttpServletRequest req)

Returns an absolute link to the path under which Fisheye/Crucible static resources are located

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
Returns
  • the link

public abstract String getUnknownAvatarAbsImgLink (HttpServletRequest req, int size)

Returns an absolute link to the placeholder avatar for unknown users

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
size the size of the required image, in pixels
Returns
  • the link

public abstract String getUserAbsLink (HttpServletRequest req, String userName)

Returns an absolute link to a user's page

Parameters
req optional request object - If omitted Fisheye/Crucible will generate a site url based on the configuration for this instance.
userName the name of the user
Returns
  • an absolute link to the user's page