Package com.atlassian.bamboo.specs.util

Class BambooServer

java.lang.Object

com.atlassian.bamboo.specs.util.BambooServer

public class BambooServer
extends Object

Represents an instance of Bamboo server for publishing entities.

Constructor Summary

Constructors

Constructor	Description
BambooServer(@NotNull String baseUrl)	Create an instance of Bamboo server.
BambooServer(@NotNull String baseUrl, @NotNull AuthenticationProvider authenticationProvider)	Create an instance of Bamboo server with specified AuthenticationProvider.

Method Summary

Modifier and Type	Method	Description
URI	getBaseUrl()	Get base URL for the Bamboo server.
Object	publish(@NotNull RootEntityPropertiesBuilder entityProperties)	Publishes the given entity to Bamboo server.

Methods inherited from class java.lang.Object

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

Constructor Detail

BambooServer

public BambooServer(@NotNull
                    @NotNull String baseUrl)

Create an instance of Bamboo server.

Parameters:

baseUrl - base URL of the Bamboo server, e.g. http://bamboo.example.com/ (ignored when in RSS mode)

BambooServer

public BambooServer(@NotNull
                    @NotNull String baseUrl,
                    @NotNull
                    @NotNull AuthenticationProvider authenticationProvider)

Create an instance of Bamboo server with specified AuthenticationProvider.

Parameters:

baseUrl - base URL of the Bamboo server, e.g. http://bamboo.example.com/ (ignored when in RSS mode)

authenticationProvider - credentials to use for contacting Bamboo (ignored when in RSS mode)

Method Detail

getBaseUrl

public URI getBaseUrl()

Get base URL for the Bamboo server.

publish

public Object publish(@NotNull
                      @NotNull RootEntityPropertiesBuilder entityProperties)

Publishes the given entity to Bamboo server. The exact behavior of this method depends on the state of RunnerSettings. In RSS mode, url and authentication parameters are ignored and calling this method on any BambooServer object results in publishing the object to the current Bamboo instance. When publishing using Maven profile (mvn -Ppublish-specs) the Specs objects are sent to a Bamboo instance located at baseUrl. See also: RssRuntimeContext

Parameters:

entityProperties - entity to publish

Returns:

result of the publishing

Throws:

BambooSpecsPublishingException - if publishing fails