jetbrains.buildServer.serverSide

Class RelativeWebLinks

java.lang.Object

jetbrains.buildServer.serverSide.RelativeWebLinks

Direct Known Subclasses:

WebLinks

public class RelativeWebLinks
extends java.lang.Object

Same as WebLinks but provides links relative to server host + context.

Since:

10.0

Constructor Summary

Constructors

Constructor and Description
RelativeWebLinks()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgentUrl(BuildAgent agent, java.lang.Integer agentTypeId)
java.lang.String	getChangeFilesUrl(long modificationId, boolean isPersonal) Returns the URL of change details page (files tab)
java.lang.String	getChangeUrl(long modificationId, boolean isPersonal)
java.lang.String	getConfigurationHomePageUrl(BuildType buildType)
java.lang.String	getCreateConfigurationPageUrl(java.lang.String projectExtId)
java.lang.String	getCreateProjectPageUrl(java.lang.String parentExtId)
java.lang.String	getDownloadAllArtefactsUrl(Build build)
java.lang.String	getDownloadArtefactUrl(java.lang.String buildTypeExternalId, long buildId, java.lang.String path)
java.lang.String	getDownloadArtefactUrl(java.lang.String buildTypeExternalId, java.lang.String buildNumber, java.lang.String path)
java.lang.String	getEditBuildFeaturesUrl(BuildType buildType)
java.lang.String	getEditConfigurationPageUrl(java.lang.String buildTypeExternalId)
java.lang.String	getEditNotificationsUrl(java.lang.String notificatorType)
java.lang.String	getEditProjectPageUrl(java.lang.String projectExternalId)
java.lang.String	getEditTemplatePageUrl(java.lang.String templateExternalId)
java.lang.String	getEditVcsRootPageUrl(java.lang.String vcsRootExternalId) Deprecated. use a version with extProjectId argument instead.
java.lang.String	getEditVcsRootPageUrl(java.lang.String extProjectId, java.lang.String vcsRootExternalId)
java.lang.String	getMutedProblemsUrl(java.lang.String projectExternalId) Returns the URL of the muted problems page.
java.lang.String	getOverviewUrl()
java.lang.String	getPersonalQueuedBuildUrl(long personalChangeId, BuildType buildType) URL of the specified personal queued build.
java.lang.String	getPluginUrl()
java.lang.String	getProjectPageUrl(java.lang.String projectExternalId)
java.lang.String	getQueuedBuildUrl(QueuedBuild queuedBuild) URL of the specified queued build.
java.lang.String	getResponsibilitiesUrl(java.lang.String projectExternalId, java.lang.String username) Returns the URL of the responsibilities (investigations) page for the specified user.
java.lang.String	getTestDetailsUrl(java.lang.String projectExternalId, long testNameId)
java.lang.String	getTestDetailsUrl(java.lang.String projectExternalId, long testNameId, java.lang.String buildTypeId)
java.lang.String	getUserNotificationsUrl()
java.lang.String	getUserSettingsUrl()
java.lang.String	getViewArtifactsUrl(Build build)
java.lang.String	getViewChangesUrl(Build build)
java.lang.String	getViewLogUrl(Build build)
java.lang.String	getViewResultsUrl(Build build)
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)

Methods inherited from class java.lang.Object

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

Constructor Detail

RelativeWebLinks

public RelativeWebLinks()

Method Detail

getViewResultsUrl

@NotNull
public java.lang.String getViewResultsUrl(@NotNull
                                                   Build build)

Parameters:

build - specified build

Returns:

URL to view results page of the specified build

getViewChangesUrl

@NotNull
public java.lang.String getViewChangesUrl(@NotNull
                                                   Build build)

Parameters:

build - specified build

Returns:

URL to view changes page of the specified build

getViewLogUrl

@NotNull
public java.lang.String getViewLogUrl(@NotNull
                                               Build build)

Parameters:

build - specified build

Returns:

URL to view log page of the specified build

getViewArtifactsUrl

@NotNull
public java.lang.String getViewArtifactsUrl(@NotNull
                                                     Build build)

Parameters:

build - specified build

Returns:

URL to view artifacts page of the specified build

getUserSettingsUrl

@NotNull
public java.lang.String getUserSettingsUrl()

Returns:

URL of the current (for the current session) user general settings page

getUserNotificationsUrl

@NotNull
public java.lang.String getUserNotificationsUrl()

Returns:

URL of the current (for the current session) user notification settings page

getDownloadArtefactUrl

@NotNull
public java.lang.String getDownloadArtefactUrl(@NotNull
                                                        java.lang.String buildTypeExternalId,
                                                        long buildId,
                                                        @NotNull
                                                        java.lang.String path)

getDownloadArtefactUrl

@NotNull
public java.lang.String getDownloadArtefactUrl(@NotNull
                                                        java.lang.String buildTypeExternalId,
                                                        @NotNull
                                                        java.lang.String buildNumber,
                                                        @NotNull
                                                        java.lang.String path)

getDownloadAllArtefactsUrl

@NotNull
public java.lang.String getDownloadAllArtefactsUrl(@NotNull
                                                            Build build)

getChangeUrl

@NotNull
public java.lang.String getChangeUrl(long modificationId,
                                              boolean isPersonal)

Parameters:

modificationId - id of modification

isPersonal - true if this modification refers to personal change

Returns:

URL of modification

getChangeFilesUrl

@NotNull
public java.lang.String getChangeFilesUrl(long modificationId,
                                                   boolean isPersonal)

Returns the URL of change details page (files tab)

Parameters:

modificationId - id of the modification

isPersonal - true if the modification is personal

Returns:

URL of modification

getQueuedBuildUrl

@NotNull
public java.lang.String getQueuedBuildUrl(@NotNull
                                                   QueuedBuild queuedBuild)

URL of the specified queued build.

Parameters:

queuedBuild - queued build

Returns:

see above

Since:

8.0

getPersonalQueuedBuildUrl

@NotNull
public java.lang.String getPersonalQueuedBuildUrl(long personalChangeId,
                                                           @NotNull
                                                           BuildType buildType)

URL of the specified personal queued build.

Parameters:

personalChangeId - personal change id

buildType - specified build configuration

Returns:

see above

Since:

8.0

getConfigurationHomePageUrl

@NotNull
public java.lang.String getConfigurationHomePageUrl(@NotNull
                                                             BuildType buildType)

Parameters:

buildType - specified build configuration

Returns:

URL of the specified configuration home page

getProjectPageUrl

@NotNull
public java.lang.String getProjectPageUrl(@NotNull
                                                   java.lang.String projectExternalId)

Parameters:

projectExternalId - specified project external id

Returns:

URL of the specified project page

getEditProjectPageUrl

@NotNull
public java.lang.String getEditProjectPageUrl(@NotNull
                                                       java.lang.String projectExternalId)

Parameters:

projectExternalId - specified project external id

Returns:

URL of the edit project page

Since:

10.0

getEditConfigurationPageUrl

@NotNull
public java.lang.String getEditConfigurationPageUrl(@NotNull
                                                             java.lang.String buildTypeExternalId)

Parameters:

buildTypeExternalId - external id of a build configuration

Returns:

URL of the edit build configuration page

Since:

10.0

getEditTemplatePageUrl

@NotNull
public java.lang.String getEditTemplatePageUrl(@NotNull
                                                        java.lang.String templateExternalId)

Parameters:

templateExternalId - external id of a build configuration template

Returns:

URL of the edit build configuration template page

Since:

10.0

getEditVcsRootPageUrl

@Deprecated
 @NotNull
public java.lang.String getEditVcsRootPageUrl(@NotNull
                                                                    java.lang.String vcsRootExternalId)

Deprecated. use a version with extProjectId argument instead.

Parameters:

vcsRootExternalId - external id of a VCS root

Returns:

URL of the edit VCS root page

Since:

10.0

getEditVcsRootPageUrl

@NotNull
public java.lang.String getEditVcsRootPageUrl(@Nullable
                                                       java.lang.String extProjectId,
                                                       @NotNull
                                                       java.lang.String vcsRootExternalId)

getCreateConfigurationPageUrl

@NotNull
public java.lang.String getCreateConfigurationPageUrl(@NotNull
                                                               java.lang.String projectExtId)

Parameters:

projectExtId - external id of a project

Returns:

URL of the create build configuration page

Since:

2017.1

getCreateProjectPageUrl

@NotNull
public java.lang.String getCreateProjectPageUrl(@NotNull
                                                         java.lang.String parentExtId)

Parameters:

parentExtId - external id of a parent project

Returns:

URL of the create project page

Since:

2017.1

getOverviewUrl

@NotNull
public java.lang.String getOverviewUrl()

Returns:

main overview page URL.

getEditNotificationsUrl

@NotNull
public java.lang.String getEditNotificationsUrl(@NotNull
                                                         java.lang.String notificatorType)

Parameters:

notificatorType - specified notificator buildType.

Returns:

URL to edit specified notificator settings

getEditBuildFeaturesUrl

@NotNull
public java.lang.String getEditBuildFeaturesUrl(@NotNull
                                                         BuildType buildType)

getPluginUrl

@NotNull
public java.lang.String getPluginUrl()

Returns:

URL to download IDEA plugin

getTestDetailsUrl

@NotNull
public java.lang.String getTestDetailsUrl(@NotNull
                                                   java.lang.String projectExternalId,
                                                   long testNameId)

Parameters:

projectExternalId - the project id

testNameId - test name id

Returns:

URL of the test details page

getTestDetailsUrl

@NotNull
public java.lang.String getTestDetailsUrl(@NotNull
                                                   java.lang.String projectExternalId,
                                                   long testNameId,
                                                   @Nullable
                                                   java.lang.String buildTypeId)

Parameters:

projectExternalId - the project id

testNameId - test name id

Returns:

URL of the test details page

Since:

7.1

getResponsibilitiesUrl

@NotNull
public java.lang.String getResponsibilitiesUrl(@NotNull
                                                        java.lang.String projectExternalId,
                                                        @NotNull
                                                        java.lang.String username)

Returns the URL of the responsibilities (investigations) page for the specified user.

Parameters:

projectExternalId - the project id

username - the username or empty string (i.e. for all users)

Returns:

responsibilities page URL

getMutedProblemsUrl

@NotNull
public java.lang.String getMutedProblemsUrl(@NotNull
                                                     java.lang.String projectExternalId)

Returns the URL of the muted problems page.

Parameters:

projectExternalId - the project id

Returns:

muted problems page URL

getAgentUrl

@Nullable
public java.lang.String getAgentUrl(@NotNull
                                              BuildAgent agent,
                                              @Nullable
                                              java.lang.Integer agentTypeId)

Returns:

URL of the agent details page or null if there is no page to display details of the agent

Since:

2017.2

prepareUrl

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

prepareProjectUrl

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

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

prepareProjectUrlByExternalBuildTypeId

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

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

prepareProjectUrlByInternalBuildTypeId

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

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

prepareProjectUrlByBuildTypeTemplateExternalId

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

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