com.atlassian.bamboo.configuration
Class AdministrationConfiguration

java.lang.Object
  extended by com.atlassian.bamboo.configuration.AdministrationConfiguration
All Implemented Interfaces:
java.io.Serializable

public class AdministrationConfiguration
extends java.lang.Object
implements java.io.Serializable

This class is a POJO holding the administrator supplied configuration.

See Also:
Serialized Form

Field Summary
static int DEFAULT_BUILD_IN_QUEUE_TIMEOUT
           
static int DEFAULT_POLLING_PERIOD
           
static java.lang.String DEFAULT_URL
           
 
Constructor Summary
AdministrationConfiguration()
           
 
Method Summary
 boolean equals(java.lang.Object o)
          Auto-generated, reflection based equals
 java.lang.String getBaseUrl()
          What is the base url for this server?
 java.lang.String getBuildDirectory()
          Deprecated. Since 1.2 - user BootstrapManager.getBuildWorkingDirectory() instead
 BuildExpiryConfig getBuildExpiryConfig()
           
 int getBuildHangedInQueueNotificationTimeout()
           
 BuildHangingConfig getBuildHangingConfig()
           
 int getDefaultRepositoryPollingPeriod()
          What's the defualt build polling period - builds can change it if they like!
 ElasticConfiguration getElasticConfig()
           
 java.lang.String getEmailFromAddress()
          What is the from email address for all emails sent out by Bamboo?
 java.lang.String getEmailPrefix()
          What is the email prefix for all emails sent out by Bamboo?
 java.lang.String getGlobalVariable(java.lang.String key)
           
 java.util.Map<java.lang.String,java.lang.String> getGlobalVariables()
           
 java.lang.String getInstanceName()
           
 java.lang.String getLicense()
          The encoded license is held in the config
 ScheduleBackupConfiguration getScheduleBackupConfiguration()
           
 java.lang.String getSmtpServer()
          What is the system's emailing server?
 java.lang.String getSystemProperty(java.lang.String key)
           
 int hashCode()
          Auto-generated, reflection based hashcode
 boolean isEnableAnonymousAccess()
           
 boolean isEnableExternalUserManagement()
           
 boolean isEnableSignup()
           
 boolean isEnableViewContactDetails()
           
 boolean isInitialised()
          Has this configuration already been defined?
 boolean isRemoteAgentFunctionEnabled()
           
 boolean isRemoteApiEnabled()
           
 boolean isUseGzipCompression()
          Should we use gzip compression to compress Bamboo web pages?

This is useful if Bamboo is being run over slow networks.

 void removeGlobalVariable(java.lang.String key)
           
 void setBaseUrl(java.lang.String baseUrl)
          Define the system base url
 void setBuildDirectory(java.lang.String buildDirectory)
          Deprecated. Since 1.2 - user BootstrapManager.setBuildWorkingDirectory(String) instead
 void setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig)
           
 void setBuildHangedInQueueNotificationTimeout(int buildHangedInQueueNotificationTimeout)
           
 void setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)
           
 void setDefaultRepositoryPollingPeriod(int repositoryPollingPeriod)
          Update the defualt build polling period!
 void setEC2LoginPrivateKey(com.atlassian.aws.ec2.EC2PrivateKey privateKey)
           
 void setElasticConfig(ElasticConfiguration elasticConfig)
           
 void setEmailFromAddress(java.lang.String emailAddress)
          Define the email address messages sent by bamboo are sent from.
 void setEmailPrefix(java.lang.String emailPrefix)
          Define the system email prefix
 void setEnableAnonymousAccess(boolean enableAnonymousAccess)
           
 void setEnableExternalUserManagement(boolean enableExternalUserManagement)
           
 void setEnableRemoteApi(boolean enableRemoteApi)
           
 void setEnableSignup(boolean enableSignup)
           
 void setEnableViewContactDetails(boolean enableViewContactDetails)
           
 void setGlobalVariable(java.lang.String key, java.lang.String value)
           
 void setInstanceName(java.lang.String instanceName)
           
 void setLicense(java.lang.String license)
           
 void setRemoteAgentFunctionEnabled(boolean enabled)
           
 void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)
           
 void setSmtpServer(java.lang.String smtpServer)
          Define the smtp server we should use
 void setSystemProperty(java.lang.String key, java.lang.String value)
           
 void setUseGzipCompression(boolean useGzipCompression)
          Specify if we should we use gzip compression to compress Bamboo web pages.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_URL

public static final java.lang.String DEFAULT_URL
See Also:
Constant Field Values

DEFAULT_POLLING_PERIOD

public static final int DEFAULT_POLLING_PERIOD
See Also:
Constant Field Values

DEFAULT_BUILD_IN_QUEUE_TIMEOUT

public static final int DEFAULT_BUILD_IN_QUEUE_TIMEOUT
See Also:
Constant Field Values
Constructor Detail

AdministrationConfiguration

public AdministrationConfiguration()
Method Detail

getSmtpServer

public java.lang.String getSmtpServer()
What is the system's emailing server?

Returns:
the smtp server we are using

setSmtpServer

public void setSmtpServer(java.lang.String smtpServer)
Define the smtp server we should use

Parameters:
smtpServer - the server url

getBaseUrl

public java.lang.String getBaseUrl()
What is the base url for this server?

Returns:
the base url

setBaseUrl

public void setBaseUrl(java.lang.String baseUrl)
Define the system base url

Parameters:
baseUrl - the url

isInitialised

public boolean isInitialised()
Has this configuration already been defined?

Returns:
true, if we have data, false otherwise

getEmailPrefix

public java.lang.String getEmailPrefix()
What is the email prefix for all emails sent out by Bamboo?

Returns:
The prefix

setEmailPrefix

public void setEmailPrefix(java.lang.String emailPrefix)
Define the system email prefix

Parameters:
emailPrefix - The email subject prefix.

getEmailFromAddress

public java.lang.String getEmailFromAddress()
What is the from email address for all emails sent out by Bamboo?

Returns:
the from email address.

setEmailFromAddress

public void setEmailFromAddress(java.lang.String emailAddress)
Define the email address messages sent by bamboo are sent from.

Parameters:
emailAddress - the from address

getDefaultRepositoryPollingPeriod

public int getDefaultRepositoryPollingPeriod()
What's the defualt build polling period - builds can change it if they like!


setDefaultRepositoryPollingPeriod

public void setDefaultRepositoryPollingPeriod(int repositoryPollingPeriod)
Update the defualt build polling period!


getBuildDirectory

public java.lang.String getBuildDirectory()
Deprecated. Since 1.2 - user BootstrapManager.getBuildWorkingDirectory() instead

Returns:

setBuildDirectory

public void setBuildDirectory(java.lang.String buildDirectory)
Deprecated. Since 1.2 - user BootstrapManager.setBuildWorkingDirectory(String) instead


isUseGzipCompression

public boolean isUseGzipCompression()
Should we use gzip compression to compress Bamboo web pages?

This is useful if Bamboo is being run over slow networks. It incurs a slight performance penalty, and may not work for non-english languages.

Returns:
true iff we require gzip compression

setUseGzipCompression

public void setUseGzipCompression(boolean useGzipCompression)
Specify if we should we use gzip compression to compress Bamboo web pages.

Parameters:
useGzipCompression -

getLicense

public java.lang.String getLicense()
The encoded license is held in the config


setLicense

public void setLicense(java.lang.String license)

isEnableSignup

public boolean isEnableSignup()

setEnableSignup

public void setEnableSignup(boolean enableSignup)

isEnableAnonymousAccess

public boolean isEnableAnonymousAccess()

setEnableAnonymousAccess

public void setEnableAnonymousAccess(boolean enableAnonymousAccess)

isEnableExternalUserManagement

public boolean isEnableExternalUserManagement()

setEnableExternalUserManagement

public void setEnableExternalUserManagement(boolean enableExternalUserManagement)

isEnableViewContactDetails

public boolean isEnableViewContactDetails()

setEnableViewContactDetails

public void setEnableViewContactDetails(boolean enableViewContactDetails)

isRemoteApiEnabled

public boolean isRemoteApiEnabled()

setEnableRemoteApi

public void setEnableRemoteApi(boolean enableRemoteApi)

setBuildExpiryConfig

public void setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig)

getBuildExpiryConfig

public BuildExpiryConfig getBuildExpiryConfig()

getElasticConfig

public ElasticConfiguration getElasticConfig()

setElasticConfig

public void setElasticConfig(ElasticConfiguration elasticConfig)

equals

public boolean equals(java.lang.Object o)
Auto-generated, reflection based equals

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Auto-generated, reflection based hashcode

Overrides:
hashCode in class java.lang.Object

setSystemProperty

public void setSystemProperty(java.lang.String key,
                              java.lang.String value)

getSystemProperty

public java.lang.String getSystemProperty(java.lang.String key)

setGlobalVariable

public void setGlobalVariable(java.lang.String key,
                              java.lang.String value)

getGlobalVariable

@Nullable
public java.lang.String getGlobalVariable(java.lang.String key)

removeGlobalVariable

public void removeGlobalVariable(java.lang.String key)

getGlobalVariables

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getGlobalVariables()

getScheduleBackupConfiguration

public ScheduleBackupConfiguration getScheduleBackupConfiguration()

setScheduleBackupConfiguration

public void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)

getInstanceName

public java.lang.String getInstanceName()

setInstanceName

public void setInstanceName(java.lang.String instanceName)

isRemoteAgentFunctionEnabled

public boolean isRemoteAgentFunctionEnabled()

setRemoteAgentFunctionEnabled

public void setRemoteAgentFunctionEnabled(boolean enabled)

getBuildHangingConfig

public BuildHangingConfig getBuildHangingConfig()

setBuildHangingConfig

public void setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)

setEC2LoginPrivateKey

public void setEC2LoginPrivateKey(com.atlassian.aws.ec2.EC2PrivateKey privateKey)

getBuildHangedInQueueNotificationTimeout

public int getBuildHangedInQueueNotificationTimeout()

setBuildHangedInQueueNotificationTimeout

public void setBuildHangedInQueueNotificationTimeout(int buildHangedInQueueNotificationTimeout)


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.