jetbrains.buildServer.serverSide

Class WebLinks

java.lang.Object

jetbrains.buildServer.serverSide.RelativeWebLinks

jetbrains.buildServer.serverSide.WebLinks

public class WebLinks
extends RelativeWebLinks

This helper creates absolute links to different TeamCity pages.

Constructor Summary

Constructors

Constructor and Description
WebLinks(RootUrlHolder urlHolder) Creates new links helper.

Method Summary

Modifier and Type	Method and Description
java.lang.String	cutOffBaseUrl(java.lang.String url) Deprecated. use RelativeWebLinks instead.
java.lang.String	getHelp(java.lang.String pageName)
java.lang.String	getHelp(java.lang.String pageName, java.lang.String anchor)
java.lang.String	getRootUrl() Deprecated. use getRootUrlByProjectExternalId or getRootUrlByProjectInternalId instead.
java.lang.String	getRootUrlByProjectExternalId(java.lang.String extProjectId) Returns root server URL by project external id.
java.lang.String	getRootUrlByProjectInternalId(java.lang.String internalId) Returns root server URL by project internal id.
protected java.lang.String	prepareProjectUrl(java.lang.String relativeUrl, java.lang.String externalProjectID) Returns URL for the particular project.
protected java.lang.String	prepareProjectUrlByBuildTypeTemplateExternalId(java.lang.String relativeUrl, java.lang.String extTemplateId) Returns URL by external build template id.
protected java.lang.String	prepareProjectUrlByExternalBuildTypeId(java.lang.String relativeUrl, java.lang.String extBuildTypeId) Returns URL by external BuildType id.
protected java.lang.String	prepareProjectUrlByInternalBuildTypeId(java.lang.String relativeUrl, java.lang.String intBuildTypeId) Returns URL by internal BuildType id.
protected java.lang.String	prepareUrl(java.lang.String relativeUrl)
void	setUrlHolder(RootUrlHolder holder) Changes server root url provider.

Methods inherited from class jetbrains.buildServer.serverSide.RelativeWebLinks

getAgentUrl, getChangeFilesUrl, getChangeUrl, getConfigurationHomePageUrl, getCreateConfigurationPageUrl, getCreateProjectPageUrl, getDownloadAllArtefactsUrl, getDownloadArtefactUrl, getDownloadArtefactUrl, getEditBuildFeaturesUrl, getEditConfigurationPageUrl, getEditNotificationsUrl, getEditProjectPageUrl, getEditTemplatePageUrl, getEditVcsRootPageUrl, getEditVcsRootPageUrl, getMutedProblemsUrl, getOverviewUrl, getPersonalQueuedBuildUrl, getPluginUrl, getProjectPageUrl, getQueuedBuildUrl, getResponsibilitiesUrl, getTestDetailsUrl, getTestDetailsUrl, getUserNotificationsUrl, getUserSettingsUrl, getViewArtifactsUrl, getViewChangesUrl, getViewLogUrl, getViewResultsUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

WebLinks

public WebLinks(@NotNull
                RootUrlHolder urlHolder)

Creates new links helper.

Parameters:

urlHolder - root URL provider.

Method Detail

setUrlHolder

public void setUrlHolder(@NotNull
                         RootUrlHolder holder)

Changes server root url provider.

Parameters:

holder - new provider.

getRootUrl

@Deprecated
 @NotNull
public java.lang.String getRootUrl()

Deprecated. use getRootUrlByProjectExternalId or getRootUrlByProjectInternalId instead.

Returns:

root server URL

getRootUrlByProjectExternalId

@NotNull
public java.lang.String getRootUrlByProjectExternalId(@Nullable
                                                               java.lang.String extProjectId)

Returns root server URL by project external id.

getRootUrlByProjectInternalId

@NotNull
public java.lang.String getRootUrlByProjectInternalId(@Nullable
                                                               java.lang.String internalId)

Returns root server URL by project internal id.

getHelp

@NotNull
public java.lang.String getHelp(@NotNull
                                         java.lang.String pageName)

Parameters:

pageName - specified page name

Returns:

URL of the specified page help

getHelp

@NotNull
public java.lang.String getHelp(@NotNull
                                         java.lang.String pageName,
                                         @Nullable
                                         java.lang.String anchor)

Parameters:

pageName - specified page name and anchor

anchor - specified anchor

Returns:

URL of the specified page help

cutOffBaseUrl

@Deprecated
 @NotNull
public java.lang.String cutOffBaseUrl(@NotNull
                                                            java.lang.String url)

Deprecated. use RelativeWebLinks instead.

Cuts the base URL off, when the link path should not include the domain.

Parameters:

url - full url

Returns:

absolute path without base URL

prepareUrl

@NotNull
protected java.lang.String prepareUrl(@NotNull
                                               java.lang.String relativeUrl)

Overrides:

prepareUrl in class RelativeWebLinks

prepareProjectUrl

@NotNull
protected java.lang.String prepareProjectUrl(@NotNull
                                                      java.lang.String relativeUrl,
                                                      @Nullable
                                                      java.lang.String externalProjectID)

Description copied from class: RelativeWebLinks

Returns URL for the particular project. Can be overloaded in children.

Overrides:

prepareProjectUrl in class RelativeWebLinks

prepareProjectUrlByExternalBuildTypeId

@NotNull
protected java.lang.String prepareProjectUrlByExternalBuildTypeId(@NotNull
                                                                           java.lang.String relativeUrl,
                                                                           @Nullable
                                                                           java.lang.String extBuildTypeId)

Description copied from class: RelativeWebLinks

Returns URL by external BuildType id. Can be overloaded in children.

Overrides:

prepareProjectUrlByExternalBuildTypeId in class RelativeWebLinks

prepareProjectUrlByInternalBuildTypeId

@NotNull
protected java.lang.String prepareProjectUrlByInternalBuildTypeId(@NotNull
                                                                           java.lang.String relativeUrl,
                                                                           @Nullable
                                                                           java.lang.String intBuildTypeId)

Description copied from class: RelativeWebLinks

Returns URL by internal BuildType id. Can be overloaded in children.

Overrides:

prepareProjectUrlByInternalBuildTypeId in class RelativeWebLinks

prepareProjectUrlByBuildTypeTemplateExternalId

@NotNull
protected java.lang.String prepareProjectUrlByBuildTypeTemplateExternalId(@NotNull
                                                                                   java.lang.String relativeUrl,
                                                                                   @Nullable
                                                                                   java.lang.String extTemplateId)

Description copied from class: RelativeWebLinks

Returns URL by external build template id. Can be overloaded in children.

Overrides:

prepareProjectUrlByBuildTypeTemplateExternalId in class RelativeWebLinks