Package com.atlassian.bamboo.specs.util

Class BambooServer

  • public class BambooServer
extends java.lang.Object
    Represents an instance of Bamboo server for publishing entities.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.net.URI getBaseUrl()
      Get base URL for the Bamboo server.
      java.lang.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 java.lang.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 java.lang.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 java.net.URI getBaseUrl()
        Get base URL for the Bamboo server.

      • publish

        public java.lang.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