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()
           
 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<ErrorDetails> getErrorMessages()
          Obtain all of the system logged error messages
 java.util.Collection<ErrorDetails> getErrorMessages(PlanKey planKey)
          Obtain all of the system logged error messages
 java.util.Collection<ErrorDetails> getErrorMessagesByAgentId(java.lang.Long agentId)
          Obtain the system logged error messages filtered by Agent Id
 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<ErrorDetails> getErrorMessages()
Obtain all of the system logged error messages

Returns:
the collection of ErrorMessages

getErrorMessages

java.util.Collection<ErrorDetails> getErrorMessages(@NotNull
                                                    PlanKey planKey)
Obtain all of the system logged error messages

Returns:
the collection of ErrorMessages

getErrorMessagesByAgentId

java.util.Collection<ErrorDetails> getErrorMessagesByAgentId(@NotNull
                                                             java.lang.Long agentId)
Obtain the system logged error messages filtered by Agent Id

Parameters:
agentId -
Returns:
the collection of ErrorMessages

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

getAdministrationConfiguration

AdministrationConfiguration getAdministrationConfiguration()


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.