Package com.atlassian.bamboo.build.logger

Class DefaultBuildLoggerManager

java.lang.Object

com.atlassian.bamboo.build.logger.DefaultBuildLoggerManager

All Implemented Interfaces:

BuildLoggerManager, FlushableBuildLoggerManager, ServerBuildLoggerManager

public class DefaultBuildLoggerManager
extends Object
implements FlushableBuildLoggerManager, ServerBuildLoggerManager

Field Summary

Fields

Modifier and Type	Field	Description
static final long	LOG_TRANSMISSION_KEEPALIVE_SECONDS

Constructor Summary

Constructors

Constructor	Description
DefaultBuildLoggerManager(@NotNull ExpiryTicker expiryTicker)

Method Summary

Modifier and Type	Method	Description
@NotNull Future<?>	flushAllFileLogs()	Flush active file logs to disk.
@NotNull FileWritingBuildLogger	getFileWritingLogger(@NotNull LoggerId<? extends Key> loggerId)	Returns a BuildLogger.
@NotNull BuildLogger	getLogger(@NotNull Key key)	Returns a BuildLogger for the given plan
@NotNull BuildLogger	getLogger(@NotNull ResultKey resultKey)	Returns a BuildLogger for the given result.
<T extends Key> @NotNull BuildLoggerWithoutLogAccess	getLoggerWithoutLogAccess(@NotNull LoggerId<T> loggerId)	Returns a BuildLoggerWithoutLogAccess for the given LoggerId
@NotNull BuildLoggerWithoutLogAccess	getLoggerWithoutLogAccess(@NotNull Key key)	Returns a BuildLoggerWithoutLogAccess for the given result
@NotNull FileWritingBuildLogger	getNonPersistentLogger(@NotNull ResultKey resultKey)	Returns a BuildLogger for the given result.
FileWritingBuildLogger	getPersistentLogger(@NotNull ResultKey resultKey)	Returns a BuildLogger for the given result.
void	removeBuildLogger(PlanKey planKey)	Removes plan logger for given plan key.
void	removeBuildLogger(PlanResultKey buildResultKey)	Removes buildLogger for finished build process.
void	removeLogger(@NotNull ResultKey resultKey)	Remove a logger if you are finished with it.
<T extends Key> void	removeLogger(LoggerId<T> loggerId)	Remove a logger if you are finished with it.
void	transferLogs(BuildLogger buildLogger, CommonContext commonContext)	Transfers log to the final location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG_TRANSMISSION_KEEPALIVE_SECONDS

public static final long LOG_TRANSMISSION_KEEPALIVE_SECONDS

See Also:

• Constant Field Values

Constructor Details

DefaultBuildLoggerManager

public DefaultBuildLoggerManager(@NotNull
 @NotNull ExpiryTicker expiryTicker)

Method Details

getLogger

@NotNull
public @NotNull BuildLogger getLogger(@NotNull
 @NotNull Key key)

Description copied from interface: BuildLoggerManager

Returns a BuildLogger for the given plan

Specified by:

getLogger in interface BuildLoggerManager

getLogger

@NotNull
public @NotNull BuildLogger getLogger(@NotNull
 @NotNull ResultKey resultKey)

Description copied from interface: BuildLoggerManager

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

Specified by:

getLogger in interface BuildLoggerManager

Returns:

getPersistentLogger

public FileWritingBuildLogger getPersistentLogger(@NotNull
 @NotNull ResultKey resultKey)

Description copied from interface: ServerBuildLoggerManager

Returns a BuildLogger for the given result. Enforces switching logger to persistent if current logger is not persistent. Internal use only.

Specified by:

getPersistentLogger in interface ServerBuildLoggerManager

getNonPersistentLogger

@NotNull
public @NotNull FileWritingBuildLogger getNonPersistentLogger(@NotNull
 @NotNull ResultKey resultKey)

Description copied from interface: ServerBuildLoggerManager

Returns a BuildLogger for the given result. Enforces switching logger to non persistent if current logger is persistent. Internal use only.

Specified by:

getNonPersistentLogger in interface ServerBuildLoggerManager

getFileWritingLogger

@NotNull
public @NotNull FileWritingBuildLogger getFileWritingLogger(@NotNull
 @NotNull LoggerId<? extends Key> loggerId)

Description copied from interface: ServerBuildLoggerManager

Returns a BuildLogger. Enforces switching persistence on/off if necessary. Internal use only.

Specified by:

getFileWritingLogger in interface ServerBuildLoggerManager

getLoggerWithoutLogAccess

@NotNull
public @NotNull BuildLoggerWithoutLogAccess getLoggerWithoutLogAccess(@NotNull
 @NotNull Key key)

Description copied from interface: BuildLoggerManager

Returns a BuildLoggerWithoutLogAccess for the given result

Specified by:

getLoggerWithoutLogAccess in interface BuildLoggerManager

Returns:

getLoggerWithoutLogAccess

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

Description copied from interface: BuildLoggerManager

Returns a BuildLoggerWithoutLogAccess for the given LoggerId

Specified by:

getLoggerWithoutLogAccess in interface BuildLoggerManager

removeBuildLogger

public void removeBuildLogger(PlanKey planKey)

Description copied from interface: BuildLoggerManager

Removes plan logger for given plan key.

Specified by:

removeBuildLogger in interface BuildLoggerManager

removeBuildLogger

public void removeBuildLogger(PlanResultKey buildResultKey)

Description copied from interface: BuildLoggerManager

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.

Specified by:

removeBuildLogger in interface BuildLoggerManager

removeLogger

public <T extends Key> void removeLogger(LoggerId<T> loggerId)

Description copied from interface: BuildLoggerManager

Remove a logger if you are finished with it.

Specified by:

removeLogger in interface BuildLoggerManager

Parameters:

loggerId - of the logger to remove

removeLogger

public void removeLogger(@NotNull
 @NotNull ResultKey resultKey)

Description copied from interface: BuildLoggerManager

Remove a logger if you are finished with it.

Specified by:

removeLogger in interface BuildLoggerManager

transferLogs

public void transferLogs(BuildLogger buildLogger,
 CommonContext commonContext)

Description copied from interface: BuildLoggerManager

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

Specified by:

transferLogs in interface BuildLoggerManager

flushAllFileLogs

@NotNull
public @NotNull Future<?> flushAllFileLogs()

Description copied from interface: FlushableBuildLoggerManager

Flush active file logs to disk.

Specified by:

flushAllFileLogs in interface FlushableBuildLoggerManager

Returns:

future that is done when all the processing is finished.