com.atlassian.bitbucket.build.server

Interface PluginBuildServer

public interface PluginBuildServer

An abstraction describing a specific instance of a CI server and methods for Bitbucket Server to interact with it.

Since:

7.8

Method Summary

Modifier and Type	Method and Description
BuildStatusEnricher	getBuildStatusEnricher()
PluginBuildServerClient	getClient()
String	getId() Identifier that uniquely identifies this build server.
String	getName()
URI	getRpcUrl()
String	getTypeId() Identifier of the type of the build server.

Method Detail

getBuildStatusEnricher

@Nonnull
BuildStatusEnricher getBuildStatusEnricher()

Returns:

a BuildStatusEnricher that can be used to add extra details to a RepositoryBuildStatus

getClient

@Nonnull
PluginBuildServerClient getClient()

Returns:

a PluginBuildServerClient that can be used to interface with this build server

getId

@Nonnull
String getId()

Identifier that uniquely identifies this build server. This may be a URL, a UUID, or some other string. It must identify the build server locally (within the scope of the provider) and additionally, as far as possible, globally. As such a simple incrementing integer value would be a poor choice of identifier.

Returns:

an id that uniquely identifies this build server

getName

@Nonnull
String getName()

Returns:

a human readable name for the build server

getRpcUrl

@Nonnull
URI getRpcUrl()

Returns:

the base URL to be used when constructing URIs to be used for RPC calls to this application. The returned URI will have no trailing slash. e.g. "http://localhost:6990/bamboo"

getTypeId

@Nonnull
String getTypeId()

Identifier of the type of the build server. For example, "bamboo" or "jenkins". For internal consumption and not an i18n string.

Returns:

the id of the type of the build server