com.atlassian.bamboo
Interface Bamboo

All Known Implementing Classes:

BambooContainer

public interface Bamboo

This interface provides a simple Facade for accessing Bamboo.

This acts as a uniform API for accessing the system - web actions, soap calls and such like all use this interface.

Field Summary

static java.lang.String

BAMBOO_KEY The key for the Bamboo instance stored in the action's servlet context

Method Summary

void	clearErrorMessages() deletes all error messages
AdministrationConfiguration	getAdministrationConfiguration()
BuilderManager	getBuilderManager() Deprecated. Since 3.1 use TaskManager instead
ErrorDetails	getBuildErrorDetails(java.lang.String buildName, int errorNumber) Obtain the errorNumber'th error for the given buildName from the internal system error log
Persister	getDefaultPersister() Which persister is the system using?
java.util.Collection<ErrorDetails>	getElasticErrorMessages() Obtain all of the logged error messages associated with elastic bamboo
java.util.Collection	getErrorMessages() Obtain all of the system logged error messages
java.util.Collection	getErrorMessages(PlanKey planKey) Obtain all of the system logged error messages
java.util.Collection	getErrorMessages(java.lang.String buildName) Deprecated. since3.0. Not type-safe. Use getErrorMessages(PlanKey).
SessionManager	getSessionManager() Which session manager is the system using?
void	removeBuildErrorFromLog(java.lang.String buildName, int errorNumber) Remove the errorNumber'th error for the given buildName from the internal system error log
void	restartComponentsFollowingConfigurationChange() Restart the components that depend on the current system configuration whenever the configuration has been changed.
void	start(javax.servlet.ServletContext servletContext) Start Bamboo
void	stop() Stop bamboo

Field Detail

BAMBOO_KEY

static final java.lang.String BAMBOO_KEY

The key for the Bamboo instance stored in the action's servlet context

See Also:

Constant Field Values

Method Detail

start

void start(@NotNull
           javax.servlet.ServletContext servletContext)
           throws java.lang.Exception

Start Bamboo

Throws:

java.lang.Exception

stop

void stop()

Stop bamboo

restartComponentsFollowingConfigurationChange

void restartComponentsFollowingConfigurationChange()

Restart the components that depend on the current system configuration whenever the configuration has been changed.

getErrorMessages

java.util.Collection getErrorMessages()

Obtain all of the system logged error messages

Returns:

the collection of ErrorMessages

getErrorMessages

java.util.Collection getErrorMessages(@NotNull
                                      PlanKey planKey)

Obtain all of the system logged error messages

Returns:

the collection of ErrorMessages

getErrorMessages

@Deprecated
java.util.Collection getErrorMessages(java.lang.String buildName)

Deprecated. since3.0. Not type-safe. Use getErrorMessages(PlanKey).

Obtain all of the logged error messages associated with a build

Parameters:

buildName - the build to check errors for

Returns:

the collection of ErrorMessage objects

getElasticErrorMessages

java.util.Collection<ErrorDetails> getElasticErrorMessages()

Obtain all of the logged error messages associated with elastic bamboo

Returns:

the collection of ErrorDetails objects

clearErrorMessages

void clearErrorMessages()

deletes all error messages

removeBuildErrorFromLog

void removeBuildErrorFromLog(java.lang.String buildName,
                             int errorNumber)

Remove the errorNumber'th error for the given buildName from the internal system error log

Parameters:

buildName - The name of the build with the associated error

errorNumber - The error number (zero based index of error associated with build)

getBuildErrorDetails

ErrorDetails getBuildErrorDetails(java.lang.String buildName,
                                  int errorNumber)

Obtain the errorNumber'th error for the given buildName from the internal system error log

Parameters:

buildName - The name of the build with the associated error

errorNumber - The error number (zero based index of error associated with build)

getDefaultPersister

Persister getDefaultPersister()

Which persister is the system using?

Returns:

The persister

getSessionManager

SessionManager getSessionManager()

Which session manager is the system using?

Returns:

The session manager

getBuilderManager

@Deprecated
BuilderManager getBuilderManager()

Deprecated. Since 3.1 use TaskManager instead

Returns:

getAdministrationConfiguration

AdministrationConfiguration getAdministrationConfiguration()