Package com.atlassian.bamboo.testutils.backdoor

Class AdministrationControl

java.lang.Object
com.atlassian.bamboo.testutils.backdoor.BackdoorControl<AdministrationControl>
com.atlassian.bamboo.testutils.backdoor.AdministrationControl
public class AdministrationControl extends BackdoorControl<AdministrationControl>

  • Constructor Details

    • AdministrationControl

      public AdministrationControl(@NotNull @NotNull BambooEnvironmentData environmentData)

  • Method Details

    • tearDown

      public void tearDown()
      Description copied from class: BackdoorControl
      Cleanup resources
      Overrides:
      tearDown in class BackdoorControl<AdministrationControl>

    • createResource

      protected javax.ws.rs.client.WebTarget createResource()
      Description copied from class: BackdoorControl
      Creates the resource that corresponds to the root of the TestKit REST API, using the values returned by BackdoorControl.getRestModulePath(). Note that the created WebResource has the following properties:
      • it logs all GET/POST/etc requests made through it
      • it sets the Content-Type: application/json by default (override with WebTarget.request(MediaType...))
      . To create a WebResource for a different root, use BackdoorControl.createResourceForPath(java.lang.String)
      Overrides:
      createResource in class BackdoorControl<AdministrationControl>
      Returns:
      a WebResource for the TestKit REST API root
      See Also:

    • logSettings

      public LogSettingsControl logSettings()

    • isAuditLogEnabled

      public boolean isAuditLogEnabled()

    • enableAuditLog

      public void enableAuditLog() throws Exception
      Throws:
      Exception

    • disableAuditLog

      public void disableAuditLog() throws Exception
      Throws:
      Exception

    • getDashboardPageSize

      public int getDashboardPageSize()

    • setDashboardPageSize

      public void setDashboardPageSize(int dashboardPageSize)

    • createGlobalVariable

      public AdministrationControl createGlobalVariable(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • addWebhookTemplate

      public AdministrationControl addWebhookTemplate(@NotNull @NotNull String name, @NotNull @NotNull String payload, @NotNull @NotNull String headers, @NotNull @NotNull UUID uuid)

    • deleteWebhookTemplate

      public AdministrationControl deleteWebhookTemplate(@NotNull @NotNull UUID uuid)

    • deleteGlobalVariable

      public AdministrationControl deleteGlobalVariable(@NotNull @NotNull String key)

    • createTemporaryGlobalVariable

      public AdministrationControl createTemporaryGlobalVariable(@NotNull @NotNull String key, @NotNull @NotNull String value)

    • getGlobalVariables

      @NotNull public @NotNull List<RestVariableDefinition> getGlobalVariables()

    • getSystemInfo

      public Map<String,String> getSystemInfo() throws Exception
      Throws:
      Exception

    • setStorageConfiguration

      public AdministrationControl setStorageConfiguration(RestStorageConfiguration storageConfiguration)

    • getStorageConfiguration

      public RestStorageConfiguration getStorageConfiguration()

    • getSecuritySettings

      public RestSecuritySettings getSecuritySettings()

    • setSecuritySettings

      public void setSecuritySettings(RestSecuritySettings settings)

    • setRestrictedAdminRole

      public void setRestrictedAdminRole(boolean enableRestrictedAdminRole)

    • setSoxComplianceModeEnabled

      public void setSoxComplianceModeEnabled(boolean enableSoxComplianceMode)

    • setAgentAssignmentModificationByUsersAllowed

      public void setAgentAssignmentModificationByUsersAllowed(boolean agentAssignmentModificationByUsersAllowed)

    • setMailServerSettings

      public void setMailServerSettings(@NotNull @NotNull MailServerSettings mailServerSettings)

    • removeMailServerSettings

      public void removeMailServerSettings()

    • getBuildConcurrencySettings

      @NotNull public @NotNull RestBuildConcurrency getBuildConcurrencySettings() throws Exception
      Returns current global build concurrency settings. Requires experimental REST admin API to be enabled.
      Throws:
      Exception

    • createTrustedSshKey

      public RestTrustedKey createTrustedSshKey(String host, String key) throws Exception
      Throws:
      Exception

    • getTrustedSshKeys

      public List<RestTrustedKey> getTrustedSshKeys()

    • deleteTrustedSshKey

      public void deleteTrustedSshKey(@NotNull @NotNull String host, @NotNull @NotNull String key)
      Remove Trusted SSH key
      Parameters:
      host -
      key -

    • setBuildConcurrencySettings

      public void setBuildConcurrencySettings(boolean enabledBuildConcurrency, Integer defaultConcurrentBuilds)
      Sets current global build concurrency settings to the given primitives. Requires experimental REST admin API to be enabled.

    • setBuildMonitoringSettings

      public void setBuildMonitoringSettings(int logQuietTime, int buildQueueTimeout)
      Sets plan monitoring settings for hung builds
      Parameters:
      logQuietTime - minutes
      buildQueueTimeout - minutes

    • setBuildMonitoringSettings

      public void setBuildMonitoringSettings(@NotNull @NotNull RestBuildMonitoring monitoringSettings)

    • setLicense

      public void setLicense(String license)

    • setGlobalExpiryConfiguration

      public void setGlobalExpiryConfiguration(@NotNull @NotNull RestCombinedExpiryConfiguration configuration)
      Turn on instance expiration policy for build and deployment results.

    • setManualEncryptionConfiguration

      public void setManualEncryptionConfiguration(boolean enabled, int invocationLimit, TimeUnit invocationLimitUnit)

    • addLightThemeLogo

      public File addLightThemeLogo() throws Exception
      Throws:
      Exception

    • addDarkThemeLogo

      public File addDarkThemeLogo() throws Exception
      Throws:
      Exception