ILogSaverListener

public interface ILogSaverListener
implements ITestInvocationListener

com.android.tradefed.result.ILogSaverListener

Known indirect subclasses

AggregatePostProcessor, AveragePostProcessor, BasePostProcessor, CollectingTestListener, ConsoleResultReporter, DeviceUnavailEmailResultReporter, EmailResultReporter, FailureEmailResultReporter, FileProtoResultReporter, FormattedGeneratorReporter, IPostProcessor, InvocationFailureEmailResultReporter, JsonHttpTestResultReporter, LegacySubprocessResultsReporter, LogSaverResultForwarder, and 13 others.

AggregatePostProcessor	A metric aggregator that gives the min, max, mean, variance and standard deviation for numeric metrics collected during multiple-iteration test runs, treating them as doubles.
AveragePostProcessor	Implementation of post processor that calculate the average of the list of metrics.
BasePostProcessor	The base `IPostProcessor` that every implementation should extend.
CollectingTestListener	A `ITestInvocationListener` that will collect all test results.
ConsoleResultReporter	Result reporter to print the test results to the console.
DeviceUnavailEmailResultReporter	An `EmailResultReporter` that will send email when invocation fails due to a device not available exception.
EmailResultReporter	A simple result reporter base class that sends emails for test results.
FailureEmailResultReporter	An `EmailResultReporter` that sends notifications if either a test failure or invocation failure occurred.
FileProtoResultReporter	Proto reporter that dumps the `TestRecord` into a file.
FormattedGeneratorReporter	Reporter that allows to generate reports in a particular format.
IPostProcessor	Post processors is a Trade Federation object meant to allow the processing of metrics and logs AFTER the tests and BEFORE result reporting.
InvocationFailureEmailResultReporter	An `EmailResultReporter` that can also restrict notifications to just invocation failures.
JsonHttpTestResultReporter	A result reporter that encode test metrics results and branch, device info into JSON and POST into an HTTP service endpoint
LegacySubprocessResultsReporter	A class for freezed subprocess results reporter which is compatible with M & N version of CTS.
LogSaverResultForwarder	A `ResultForwarder` for saving logs with the global file saver.
MetricsXMLResultReporter	MetricsXMLResultReporter writes test metrics and run metrics to an XML file in a folder specified by metrics-folder parameter at the invocationEnded phase of the test.
ModuleListener	Listener attached to each `IRemoteTest` of each module in order to collect the list of results.
ProtoResultReporter	Result reporter build a `TestRecord` protobuf with all the results inside.
ResultAndLogForwarder	Forwarder for results and logs events.
ShardListener	A `ITestInvocationListener` that collects results from a invocation shard (aka an invocation split to run on multiple resources in parallel), and forwards them to another listener.
ShardMasterResultForwarder	A `ResultForwarder` that combines the results of a sharded test invocations.
StreamProtoResultReporter	An implementation of `ProtoResultReporter`
SubprocessResultsReporter	Implements `ITestInvocationListener` to be specified as a result_reporter and forward from the subprocess the results of tests, test runs, test invocations.
SuiteResultReporter	Collect test results for an entire suite invocation and output the final results.
TestFailureEmailResultReporter	An `EmailResultReporter` that can also restrict notifications to just test failures.
TextResultReporter	A test result reporter that forwards results to the JUnit text result printer.
XmlFormattedGeneratorReporter	Implementation of the `FormattedGeneratorReporter` which format the suite results in an xml format.
XmlResultReporter	Writes JUnit results to an XML files in a format consistent with Ant's XMLJUnitResultFormatter.

Allows for ITestInvocationListeners to listen for when log files are saved.

This allows for multiple ITestInvocationListeners to use the same saved log file when generating reports, and avoids having each listener save the file individually when ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) is called.

Classes implementing this interface should be aware that testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) will be called whenever ITestInvocationListener#testLog(String, LogDataType, InputStreamSource) is called.

This class also passes the global ILogSaver instance so ITestInvocationListeners can save additional files in the same location.

Summary

Public methods
`default void`	`logAssociation(String dataName, LogFile logFile)` In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct `testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)` callback is not possible.
`default void`	`setLogSaver(ILogSaver logSaver)` Set the `ILogSaver` to allow the implementor to save files.
`default void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)` Called when the test log is saved.

Public methods

logAssociation

public void logAssociation (String dataName, 
                LogFile logFile)

In some cases, log must be strongly associated with a test cases, but the opportunity to do so on the direct testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) callback is not possible. Thus, this callback allows to provide a strong association explicitly.

Parameters
`dataName`	`String`: The name of the data
`logFile`	`LogFile`: the `LogFile` that was logged before and should be associated with the test case.

setLogSaver

public void setLogSaver (ILogSaver logSaver)

Set the ILogSaver to allow the implementor to save files.

Parameters
`logSaver`	`ILogSaver`: the `ILogSaver`

testLogSaved

public void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

Called when the test log is saved.

Should be used in place of ITestInvocationListener#testLog(String, LogDataType, InputStreamSource).

Parameters
`dataName`	`String`: a `String` descriptive name of the data. e.g. "device_logcat". Note dataName may not be unique per invocation. ie implementers must be able to handle multiple calls with same dataName
`dataType`	`LogDataType`: the `LogDataType` of the data
`dataStream`	`InputStreamSource`: the `InputStreamSource` of the data. Implementers should call createInputStream to start reading the data, and ensure to close the resulting InputStream when complete.
`logFile`	`LogFile`: the `LogFile` containing the meta data of the saved file.