com.atlassian.bamboo.build

Interface BuildLoggerManager

All Known Subinterfaces:

FlushableBuildLoggerManager, ServerBuildLoggerManager

All Known Implementing Classes:

BuildLoggerManagerForTesting, DefaultBuildLoggerManager, RemoteBuildLoggerManager

public interface BuildLoggerManager

Manages instances of BuildLogger

Method Summary

Modifier and Type	Method and Description
BuildLogger	getLogger(Key key) Returns a BuildLogger for the given plan
BuildLogger	getLogger(ResultKey resultKey) Returns a BuildLogger for the given result.
BuildLoggerWithoutLogAccess	getLoggerWithoutLogAccess(Key resultKey) Returns a BuildLoggerWithoutLogAccess for the given result
<T extends Key> BuildLoggerWithoutLogAccess	getLoggerWithoutLogAccess(LoggerId<T> loggerId) Returns a BuildLoggerWithoutLogAccess for the given LoggerId
void	removeBuildLogger(PlanKey planKey) Removes plan logger for given plan key.
void	removeBuildLogger(PlanResultKey buildResultKey) Removes buildLogger for finished build process.
void	removeLogger(LoggerId loggerId) Remove a logger if you are finished with it.
void	removeLogger(ResultKey resultKey) Remove a logger if you are finished with it.
void	transferLogs(BuildLogger buildLogger, CommonContext context) Transfers log to the final location.

Method Detail

getLogger

@NotNull
BuildLogger getLogger(@NotNull
                               Key key)

Returns a BuildLogger for the given plan

Parameters:

key@return -

getLogger

@NotNull
BuildLogger getLogger(@NotNull
                               ResultKey resultKey)

Returns a BuildLogger for the given result. Does not guarantee a persistent logger.

Parameters:

resultKey -

Returns:

getLoggerWithoutLogAccess

@NotNull
BuildLoggerWithoutLogAccess getLoggerWithoutLogAccess(@NotNull
                                                               Key resultKey)

Returns a BuildLoggerWithoutLogAccess for the given result

Parameters:

resultKey -

Returns:

getLoggerWithoutLogAccess

@NotNull
<T extends Key> BuildLoggerWithoutLogAccess getLoggerWithoutLogAccess(@NotNull
                                                                               LoggerId<T> loggerId)

Returns a BuildLoggerWithoutLogAccess for the given LoggerId

Parameters:

loggerId -

Since:

7.0

removeBuildLogger

void removeBuildLogger(PlanKey planKey)

Removes plan logger for given plan key.

Parameters:

planKey -

removeBuildLogger

void removeBuildLogger(PlanResultKey buildResultKey)

Removes buildLogger for finished build process. Removed build logger is not used anymore as build has been finished and build result should be persisted already.

Parameters:

buildResultKey -

removeLogger

void removeLogger(@NotNull
                  ResultKey resultKey)

Remove a logger if you are finished with it.

Parameters:

resultKey -

removeLogger

void removeLogger(LoggerId loggerId)

Remove a logger if you are finished with it.

Parameters:

loggerId - of the logger to remove

transferLogs

void transferLogs(BuildLogger buildLogger,
                  CommonContext context)

Transfers log to the final location. Called when the build/deployment is finished.