|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 String |
BAMBOO_KEY
The key for the Bamboo instance stored in the action's servlet context |
Method Summary | |
---|---|
void |
addBuildListener(BuildEventListener listener)
Register the given build listener with system build detector |
void |
clearErrorMessages()
deletes all error messages |
void |
deleteBuild(Build build)
Remove the build from the system |
void |
deleteBuildResults(Build build,
long buildNumber)
Remove the build's build results |
AdministrationConfiguration |
getAdministrationConfiguration()
|
Collection |
getAllBuildJdks()
Get all the available JDKs. |
File |
getBuildDirectory()
What is the root build directory? The build directory is where builds are checked out and built. |
Map |
getBuilderLabelPathMaps()
Get all the currently registered builders |
BuilderManager |
getBuilderManager()
|
ErrorDetails |
getBuildErrorDetails(String buildName,
int errorNumber)
Obtain the errorNumber'th error for the given buildName from the internal system error log |
BuildExpiryConfiguration |
getBuildExpiryConfiguration()
Obtain the system's build expiry configuration |
List |
getBuildQueues()
Obtain the system's build queue. |
BuildResults |
getBuildResults(Build build,
long buildNumber)
Get the n'th build build results for the given build |
Build |
getBuildWithKey(String buildKey)
Deprecated. Use BuildManager.getBuildByKey(String) instead |
Persister |
getDefaultPersister()
Which persister is the system using? |
Collection |
getErrorMessages()
Obtain all of the system logged error messages |
Collection |
getErrorMessages(String buildName)
Obtain all of the logged error messages associated with a build |
Collection |
getRepositories()
Get all the currently registered repositories |
Repository |
getRepository(String repositoryName)
Get a specific repository |
SessionManager |
getSessionManager()
Which session manager is the system using? |
String |
getVersion()
What is the version of the application |
boolean |
isInitialised()
Has the system been initialised correctly? |
void |
killBuild(Build build,
User user)
Remove the build from the build queue. |
void |
removeBuildErrorFromLog(String buildName,
int errorNumber)
Remove the errorNumber'th error for the given buildName from the internal system error log |
void |
removeBuildFromQueues(Build build)
|
void |
restartComponentsFollowingConfigurationChange()
Restart the components that depend on the current system configuration whenever the configuration has been changed. |
void |
setBuildExpiryConfiguration(BuildExpiryConfiguration buildExpiryConfiguration)
Adjust the system's build expiry confguration |
void |
start()
Start Bamboo |
void |
stop()
Stop bamboo |
Field Detail |
---|
static final String BAMBOO_KEY
Method Detail |
---|
boolean isInitialised()
void addBuildListener(BuildEventListener listener)
listener
- The listenervoid deleteBuild(Build build)
build
- The build to removevoid deleteBuildResults(Build build, long buildNumber)
build
- The build who's build we are deletingbuildNumber
- The number of the build to deleteCollection getAllBuildJdks()
Collection getRepositories()
Repository getRepository(String repositoryName)
repositoryName
- The name of the desired repository
Map getBuilderLabelPathMaps()
List getBuildQueues()
Build getBuildWithKey(String buildKey)
BuildManager.getBuildByKey(String)
instead
buildKey
- the unique build key
BuildResults getBuildResults(Build build, long buildNumber)
build
- The buildbuildNumber
- The buildNumber of the desired build
void killBuild(Build build, User user)
build
- The build who's build we want to killuser
- void start()
void stop()
void restartComponentsFollowingConfigurationChange()
String getVersion()
File getBuildDirectory()
Collection getErrorMessages()
Collection getErrorMessages(String buildName)
void clearErrorMessages()
void removeBuildErrorFromLog(String buildName, int errorNumber)
buildName
- The name of the build with the associated errorerrorNumber
- The error number (zero based index of error associated with build)ErrorDetails getBuildErrorDetails(String buildName, int errorNumber)
buildName
- The name of the build with the associated errorerrorNumber
- The error number (zero based index of error associated with build)Persister getDefaultPersister()
SessionManager getSessionManager()
BuildExpiryConfiguration getBuildExpiryConfiguration()
void setBuildExpiryConfiguration(BuildExpiryConfiguration buildExpiryConfiguration)
buildExpiryConfiguration
- BuilderManager getBuilderManager()
AdministrationConfiguration getAdministrationConfiguration()
void removeBuildFromQueues(Build build)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |