org.acra

Class ErrorReporter

java.lang.Object

org.acra.ErrorReporter

All Implemented Interfaces:

java.lang.Thread.UncaughtExceptionHandler

public class ErrorReporter
extends java.lang.Object
implements java.lang.Thread.UncaughtExceptionHandler

The ErrorReporter is a Singleton object in charge of collecting crash context data and sending crash reports. It registers itself as the Application's Thread default Thread.UncaughtExceptionHandler.

When a crash occurs, it collects data of the crash context (device, system, stack trace...) and writes a report file in the application private directory. This report file is then sent:

• immediately if ReportsCrashes.mode() is set to ReportingInteractionMode.SILENT or ReportingInteractionMode.TOAST,
• on application start if in the previous case the transmission could not technically be made,
• when the user accepts to send it if ReportsCrashes.mode() is set to ReportingInteractionMode.NOTIFICATION.

If an error occurs while sending a report, it is kept for later attempts.

Method Summary

Modifier and Type	Method and Description
void	addCustomData(java.lang.String key, java.lang.String value) Deprecated.
void	checkReportsOnApplicationStart() Deprecated. since 4.8.0 No replacement.
void	clearCustomData() Removes all key/value pairs from your reports custom data field.
java.lang.String	getCustomData(java.lang.String key) Gets the current value for a key in your reports custom data field.
void	handleException(java.lang.Throwable e) Send a report for a Throwable with the reporting interaction mode configured by the developer, the application is then killed and restarted by the system.
void	handleException(java.lang.Throwable e, boolean endApplication) Send a report for a Throwable with the reporting interaction mode configured by the developer.
void	handleSilentException(java.lang.Throwable e) Mark this report as silent as send it.
java.lang.String	putCustomData(java.lang.String key, java.lang.String value) Use this method to provide the ErrorReporter with data of your running application.
java.lang.String	removeCustomData(java.lang.String key) Removes a key/value pair from your reports custom data field.
void	setEnabled(boolean enabled) Enable or disable this ErrorReporter.
void	setExceptionHandlerInitializer(ExceptionHandlerInitializer initializer) Deprecated. since 4.8.0 use ReportPrimer mechanism instead.
void	uncaughtException(java.lang.Thread t, java.lang.Throwable e)

Methods inherited from class java.lang.Object

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

Method Detail

addCustomData

@Deprecated
public void addCustomData(@NonNull
                                       java.lang.String key,
                                       java.lang.String value)

Deprecated.

Deprecated. Use putCustomData(String, String).

Parameters:

key - A key for your custom data.

value - The value associated to your key.

putCustomData

public java.lang.String putCustomData(@NonNull
                                      java.lang.String key,
                                      java.lang.String value)

Use this method to provide the ErrorReporter with data of your running application. You should call this at several key places in your code the same way as you would output important debug data in a log file. Only the latest value is kept for each key (no history of the values is sent in the report).

Parameters:

key - A key for your custom data.

value - The value associated to your key.

Returns:

The previous value for this key if there was one, or null.

See Also:

removeCustomData(String), getCustomData(String)

setExceptionHandlerInitializer

public void setExceptionHandlerInitializer(@Nullable
                                           ExceptionHandlerInitializer initializer)

Deprecated. since 4.8.0 use ReportPrimer mechanism instead.

Use this method to perform additional initialization before the ErrorReporter handles a throwable. This can be used, for example, to put custom data using putCustomData(String, String), which is not available immediately after startup. It can be, for example, last 20 requests or something else. The call is thread safe.

ExceptionHandlerInitializer.initializeExceptionHandler(ErrorReporter) will be executed on the main thread in case of uncaught exception and on the caller thread of handleSilentException(Throwable) or handleException(Throwable).

Example. Add to the Application.onCreate():

 ACRA.getErrorReporter().setExceptionHandlerInitializer(new ExceptionHandlerInitializer() {
     @Override public void initializeExceptionHandler(ErrorReporter reporter) {
         reporter.putCustomData("CUSTOM_ACCUMULATED_DATA_TAG", someAccumulatedData.toString);
     }
 });
 

Parameters:

initializer - The initializer. Can be null.

removeCustomData

public java.lang.String removeCustomData(@NonNull
                                         java.lang.String key)

Removes a key/value pair from your reports custom data field.

Parameters:

key - The key of the data to be removed.

Returns:

The value for this key before removal.

See Also:

putCustomData(String, String), getCustomData(String)

clearCustomData

public void clearCustomData()

Removes all key/value pairs from your reports custom data field.

getCustomData

public java.lang.String getCustomData(@NonNull
                                      java.lang.String key)

Gets the current value for a key in your reports custom data field.

Parameters:

key - The key of the data to be retrieved.

Returns:

The value for this key.

See Also:

putCustomData(String, String), removeCustomData(String)

uncaughtException

public void uncaughtException(@Nullable
                              java.lang.Thread t,
                              @NonNull
                              java.lang.Throwable e)

Specified by:

uncaughtException in interface java.lang.Thread.UncaughtExceptionHandler

handleSilentException

public void handleSilentException(@Nullable
                                  java.lang.Throwable e)

Mark this report as silent as send it.

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

setEnabled

public void setEnabled(boolean enabled)

Enable or disable this ErrorReporter. By default it is enabled.

Parameters:

enabled - Whether this ErrorReporter should capture Exceptions and forward them as crash reports.

checkReportsOnApplicationStart

public void checkReportsOnApplicationStart()

Deprecated. since 4.8.0 No replacement.

This method looks for pending reports and does the action required depending on the interaction mode set. There is no need to call this method as ACRA will by default check for errors on report start. Whether ACRA checks for reports on app start is controlled by ACRA.init(Application, ACRAConfiguration, boolean), but the default is that it will.

handleException

public void handleException(@Nullable
                            java.lang.Throwable e,
                            boolean endApplication)

Send a report for a Throwable with the reporting interaction mode configured by the developer.

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").

endApplication - Set this to true if you want the application to be ended after sending the report.

handleException

public void handleException(@Nullable
                            java.lang.Throwable e)

Send a report for a Throwable with the reporting interaction mode configured by the developer, the application is then killed and restarted by the system.

Parameters:

e - The Throwable to be reported. If null the report will contain a new Exception("Report requested by developer").