Package com.atlassian.bamboo.build.logger

Interface BuildLoggerWithoutLogAccess

All Known Subinterfaces:

BuildLogger, FileWritingBuildLogger

All Known Implementing Classes:

AbstractBuildLogger, BuildLoggerImpl, DisconnectedBuildLogger, NullBuildLogger, RemoteBuildLogger, SimpleBuildLogger

public interface BuildLoggerWithoutLogAccess

Method Summary

Modifier and Type	Method	Description
@NotNull String	addBuildLogEntry(@NotNull LogEntry logEntry)	Add a new build log entry.
String	addBuildLogEntry(@NotNull String logString)	Create a new build log entry from text to append to logs
@NotNull String	addErrorLogEntry(@NotNull LogEntry logEntry)	Add a new build error log entry.
String	addErrorLogEntry(String logString)	Add a new build error log entry from text.
void	addErrorLogEntry(String logString, @Nullable Throwable e)	Adds an error log entry and each frame of the stack trace as a new error log entry
void	close()
@NotNull LogInterceptorStack	getInterceptorStack()
@NotNull LogMutatorStack	getMutatorStack()
long	getTimeOfLastLog()	last time a log entry was added.
boolean	isPersistent()
void	setTimeOfLastLog(long timeOfLastLog)	set time of last log.
void	stopStreamingBuildLogs()	Stop streaming any logs to the build logs file
default boolean	transfersLogsAsArtifact()

Method Detail

addBuildLogEntry

@NotNull
@NotNull String addBuildLogEntry(@NotNull
                                 @NotNull LogEntry logEntry)

Add a new build log entry. This will get appended to the end of the log.

Parameters:

logEntry - The data being logged

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addBuildLogEntry

String addBuildLogEntry(@NotNull
                        @NotNull String logString)

Create a new build log entry from text to append to logs

Parameters:

logString - text to create log entry from

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addErrorLogEntry

@NotNull
@NotNull String addErrorLogEntry(@NotNull
                                 @NotNull LogEntry logEntry)

Add a new build error log entry. This will get appended to the end of the log and to the end of the errors.

Parameters:

logEntry - The data being logged

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addErrorLogEntry

String addErrorLogEntry(String logString)

Add a new build error log entry from text. This will get appended to the end of the log and to the end of the errors.

Parameters:

logString - The text to create log entry from

Returns:

The line of text being logged. From LogEntry.getUnstyledLog().

addErrorLogEntry

void addErrorLogEntry(String logString,
                      @Nullable
                      @Nullable Throwable e)

Adds an error log entry and each frame of the stack trace as a new error log entry

Parameters:

logString -

e -

stopStreamingBuildLogs

void stopStreamingBuildLogs()

Stop streaming any logs to the build logs file

getTimeOfLastLog

long getTimeOfLastLog()

last time a log entry was added. If no logs, returns 0

Returns:

setTimeOfLastLog

void setTimeOfLastLog(long timeOfLastLog)

set time of last log. Used for loading buildings in progress after restarts

getInterceptorStack

@NotNull
@NotNull LogInterceptorStack getInterceptorStack()

Returns:

stack of log interceptors attached to this build logger

getMutatorStack

@NotNull
@NotNull LogMutatorStack getMutatorStack()

Returns:

stack of log mutators attached to this build logger

close

void close()

transfersLogsAsArtifact

default boolean transfersLogsAsArtifact()

isPersistent

boolean isPersistent()

Returns:

true if underlying logger saves to disk

Since:

7.1