com.atlassian.fisheye.spi.services

Interface LinkService

public interface LinkService

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

Method Summary

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

Method Detail

getChangelogAbsLink

java.lang.String getChangelogAbsLink(javax.servlet.http.HttpServletRequest req,
                                     java.lang.String repositoryName,
                                     java.lang.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 repository key

Returns:

an absolute link to the Fisheye changelog page

getChangesetAbsLink

java.lang.String getChangesetAbsLink(javax.servlet.http.HttpServletRequest req,
                                     java.lang.String repositoryName,
                                     java.lang.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 repository key

csid - the changeset id

Returns:

an absolute link to the Fisheye changeset page

getProjectAbsLink

java.lang.String getProjectAbsLink(javax.servlet.http.HttpServletRequest req,
                                   java.lang.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

getReviewAbsLink

java.lang.String getReviewAbsLink(javax.servlet.http.HttpServletRequest req,
                                  java.lang.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

getCommiterAbsLink

java.lang.String getCommiterAbsLink(javax.servlet.http.HttpServletRequest req,
                                    java.lang.String repositoryName,
                                    java.lang.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 key of the repository

committerName - the name of the commiter

Returns:

an absolute link to the commiter's page

getUserAbsLink

java.lang.String getUserAbsLink(javax.servlet.http.HttpServletRequest req,
                                java.lang.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

getAvatarAbsImgLink

java.lang.String getAvatarAbsImgLink(javax.servlet.http.HttpServletRequest req,
                                     java.lang.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

getDeletedAvatarAbsImgLink

java.lang.String getDeletedAvatarAbsImgLink(javax.servlet.http.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

getUnknownAvatarAbsImgLink

java.lang.String getUnknownAvatarAbsImgLink(javax.servlet.http.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

getStaticPathAbsLink

java.lang.String getStaticPathAbsLink(javax.servlet.http.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