com.atlassian.bamboo.build.logger
Interface BuildLogger

All Known Implementing Classes:
BuildLoggerImpl, RemoteBuildLogger, SimpleBuildLogger

public interface BuildLogger

This interface represents a logger for a given build


Method Summary
 java.lang.String addBuildLogEntry(LogEntry logEntry)
          Add a new build log entry.
 java.lang.String addBuildLogEntry(java.lang.String logString)
          Create a new build log entry from text to append to logs
 java.lang.String addErrorLogEntry(LogEntry logEntry)
          Add a new build error log entry.
 java.lang.String addErrorLogEntry(java.lang.String logString)
          Add a new build error log entry from text.
 void clearBuildLog()
          Reset the build log, ready for the next build
 java.util.List<LogEntry> getBuildLog()
          Provide the latest build details (last 100 lines of logs).
 java.util.List<LogEntry> getErrorLog()
          Provide the latest error logs.
 java.util.List<java.lang.String> getStringErrorLogs()
           
 void startStreamingBuildLogs(int buildNum, java.lang.String planKey)
          Begin streaming any logs to build logs file
 void stopStreamingBuildLogs()
          Stop streaming any logs to the build logs file
 

Method Detail

getBuildLog

java.util.List<LogEntry> getBuildLog()
Provide the latest build details (last 100 lines of logs). This is not persisted.

Returns:
The list of LogEntrys. May return null.

getErrorLog

java.util.List<LogEntry> getErrorLog()
Provide the latest error logs. This is not persisted

Returns:
The list of LogEntrys. May return null.

getStringErrorLogs

java.util.List<java.lang.String> getStringErrorLogs()

addBuildLogEntry

java.lang.String addBuildLogEntry(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

java.lang.String addBuildLogEntry(java.lang.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

java.lang.String addErrorLogEntry(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

java.lang.String addErrorLogEntry(java.lang.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().

startStreamingBuildLogs

void startStreamingBuildLogs(int buildNum,
                             java.lang.String planKey)
Begin streaming any logs to build logs file

Parameters:
buildNum -
planKey -

stopStreamingBuildLogs

void stopStreamingBuildLogs()
Stop streaming any logs to the build logs file


clearBuildLog

void clearBuildLog()
Reset the build log, ready for the next build



Copyright © 2008 Atlassian Pty Ltd. All Rights Reserved.