org.acra.config

Class CoreConfigurationBuilder

java.lang.Object

org.acra.config.CoreConfigurationBuilder

All Implemented Interfaces:

ConfigurationBuilder

public final class CoreConfigurationBuilder
extends Object
implements ConfigurationBuilder

Class generated based on AcraCore (04.02.2019 03:17:10)

Constructor Summary

Constructors

Constructor and Description
CoreConfigurationBuilder(Context arg0)

Method Summary

Modifier and Type	Method and Description
CoreConfiguration	build() Builds the configuration
<R extends ConfigurationBuilder> R	getPluginConfigurationBuilder(Class<R> c)
CoreConfigurationBuilder	setAdditionalDropBoxTags(String... additionalDropBoxTags) Custom tags to be included in DropBox event collection
CoreConfigurationBuilder	setAdditionalSharedPreferences(String... additionalSharedPreferences) Add here your SharedPreferences identifier Strings if you use others than your application's default.
CoreConfigurationBuilder	setAlsoReportToAndroidFramework(boolean alsoReportToAndroidFramework) Set this to true if you prefer displaying the native force close dialog after ACRA is done.
CoreConfigurationBuilder	setApplicationLogFile(String applicationLogFile) To use in combination with ReportField.APPLICATION_LOG to set the path/name of your application log file.
CoreConfigurationBuilder	setApplicationLogFileDir(Directory applicationLogFileDir) To use in combination with ReportField.APPLICATION_LOG to set the root for the path provided in applicationLogFile()
CoreConfigurationBuilder	setApplicationLogFileLines(int applicationLogFileLines) To use in combination with ReportField.APPLICATION_LOG to set the number of latest lines of your application log file to be collected.
CoreConfigurationBuilder	setAttachmentUriProvider(Class<? extends AttachmentUriProvider> attachmentUriProvider) Allows attachmentUris() configuration at runtime instead of compile time.
CoreConfigurationBuilder	setAttachmentUris(String... attachmentUris) Allows to attach files to crash reports.
CoreConfigurationBuilder	setBuildConfigClass(Class buildConfigClass) The default value will be a BuildConfig class residing in the same package as the Application class.
CoreConfigurationBuilder	setDeleteOldUnsentReportsOnApplicationStart(boolean deleteOldUnsentReportsOnApplicationStart) This property can be used to determine whether old (out of date) reports should be sent or not.
CoreConfigurationBuilder	setDeleteUnapprovedReportsOnApplicationStart(boolean deleteUnapprovedReportsOnApplicationStart) Controls whether unapproved reports are deleted on application start or not.
CoreConfigurationBuilder	setDropboxCollectionMinutes(int dropboxCollectionMinutes) DropBox event collection will look back this many minutes
CoreConfigurationBuilder	setEnabled(boolean enabled)
CoreConfigurationBuilder	setExcludeMatchingSettingsKeys(String... excludeMatchingSettingsKeys) Provide here regex patterns to be evaluated on each Settings.System, Settings.Secure and Settings.Global key to exclude KV pairs from being collected.
CoreConfigurationBuilder	setExcludeMatchingSharedPreferencesKeys(String... excludeMatchingSharedPreferencesKeys) Provide here regex patterns to be evaluated on each SharedPreferences key to exclude KV pairs from the collected SharedPreferences.
CoreConfigurationBuilder	setIncludeDropBoxSystemTags(boolean includeDropBoxSystemTags) If enabled, DropBox events collection will include system tags: system_app_anr system_app_wtf system_app_crash system_server_anr system_server_wtf system_server_crash BATTERY_DISCHARGE_INFO SYSTEM_RECOVERY_LOG SYSTEM_BOOT SYSTEM_LAST_KMSG APANIC_CONSOLE APANIC_THREADS SYSTEM_RESTART SYSTEM_TOMBSTONE data_app_strictmode
CoreConfigurationBuilder	setLogcatArguments(String... logcatArguments) Arguments to be passed to the logcat command line.
CoreConfigurationBuilder	setLogcatFilterByPid(boolean logcatFilterByPid) Set this to true if you want to include only logcat lines related to your Application process.
CoreConfigurationBuilder	setLogcatReadNonBlocking(boolean logcatReadNonBlocking) Set this to true if you want to read logcat lines in a non blocking way for your thread.
CoreConfigurationBuilder	setParallel(boolean parallel) Allow parallel collection.
CoreConfigurationBuilder	setPluginLoader(PluginLoader pluginLoader) Set a custom plugin loader.
CoreConfigurationBuilder	setReportContent(ReportField... reportContent) Redefines the list of ReportFields collected and sent in your reports.
CoreConfigurationBuilder	setReportField(ReportField field, boolean enable) Use this if you want to keep the default configuration of reportContent, but set some fields explicitly.
CoreConfigurationBuilder	setReportFormat(StringFormat reportFormat) Format in which the report should be sent
CoreConfigurationBuilder	setReportSenderFactoryClasses(Class<? extends ReportSenderFactory>... reportSenderFactoryClasses) Deprecated. register with plugin loading instead
CoreConfigurationBuilder	setReportSendFailureToast(String reportSendFailureToast) Toast shown when report sending fails
CoreConfigurationBuilder	setReportSendSuccessToast(String reportSendSuccessToast) Toast shown when a report is sent successfully
CoreConfigurationBuilder	setResReportSendFailureToast(int resReportSendFailureToast) Toast shown when report sending fails
CoreConfigurationBuilder	setResReportSendSuccessToast(int resReportSendSuccessToast) Toast shown when a report is sent successfully
CoreConfigurationBuilder	setRetryPolicyClass(Class<? extends RetryPolicy> retryPolicyClass) Implement a custom RetryPolicy to decide if a failed report should be resent or not.
CoreConfigurationBuilder	setSendReportsInDevMode(boolean sendReportsInDevMode) Set this to false if you want to disable sending reports in development mode.
CoreConfigurationBuilder	setSharedPreferencesName(String sharedPreferencesName) Name of the SharedPreferences that will host ACRA settings which you can make accessible to your users through a preferences screen: ACRA.PREF_DISABLE_ACRA or ACRA.PREF_ENABLE_ACRA ACRA.PREF_ALWAYS_ACCEPT ACRA.PREF_ENABLE_DEVICE_ID ACRA.PREF_ENABLE_SYSTEM_LOGS Default is to use the application default SharedPreferences, as retrieved with PreferenceManager.getDefaultSharedPreferences(android.content.Context)
CoreConfigurationBuilder	setStopServicesOnCrash(boolean stopServicesOnCrash) If you have services which might crash on startup android will try to restart them indefinitely.

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreConfigurationBuilder

public CoreConfigurationBuilder(@NonNull
                                Context arg0)

Parameters:

arg0 - object annotated with AcraCore

Method Detail

setEnabled

@NonNull
public CoreConfigurationBuilder setEnabled(boolean enabled)

setSharedPreferencesName

@NonNull
public CoreConfigurationBuilder setSharedPreferencesName(@NonNull
                                                                  String sharedPreferencesName)

Name of the SharedPreferences that will host ACRA settings which you can make accessible to your users through a preferences screen:

• ACRA.PREF_DISABLE_ACRA or ACRA.PREF_ENABLE_ACRA
• ACRA.PREF_ALWAYS_ACCEPT
• ACRA.PREF_ENABLE_DEVICE_ID
• ACRA.PREF_ENABLE_SYSTEM_LOGS

Default is to use the application default SharedPreferences, as retrieved with PreferenceManager.getDefaultSharedPreferences(android.content.Context)

Parameters:

sharedPreferencesName - SharedPreferences name.

Returns:

this instance

setIncludeDropBoxSystemTags

@NonNull
public CoreConfigurationBuilder setIncludeDropBoxSystemTags(boolean includeDropBoxSystemTags)

If enabled, DropBox events collection will include system tags:

• system_app_anr
• system_app_wtf
• system_app_crash
• system_server_anr
• system_server_wtf
• system_server_crash
• BATTERY_DISCHARGE_INFO
• SYSTEM_RECOVERY_LOG
• SYSTEM_BOOT
• SYSTEM_LAST_KMSG
• APANIC_CONSOLE
• APANIC_THREADS
• SYSTEM_RESTART
• SYSTEM_TOMBSTONE
• data_app_strictmode

Parameters:

includeDropBoxSystemTags - if system tags are to be included as part of DropBox events.

Returns:

this instance

setAdditionalDropBoxTags

@NonNull
public CoreConfigurationBuilder setAdditionalDropBoxTags(@NonNull
                                                                  String... additionalDropBoxTags)

Custom tags to be included in DropBox event collection

Parameters:

additionalDropBoxTags - tags that you want to be fetched when collecting DropBox events.

Returns:

this instance

setDropboxCollectionMinutes

@NonNull
public CoreConfigurationBuilder setDropboxCollectionMinutes(int dropboxCollectionMinutes)

DropBox event collection will look back this many minutes

Parameters:

dropboxCollectionMinutes - Number of minutes to look back.

Returns:

this instance

setLogcatArguments

@NonNull
public CoreConfigurationBuilder setLogcatArguments(@NonNull
                                                            String... logcatArguments)

Arguments to be passed to the logcat command line. Default is { "-t", "100", "-v", "time" } for:

logcat -t 100 -v time

Do not include -b arguments for buffer selection, include ReportField.EVENTSLOG and ReportField.RADIOLOG in reportContent() to activate alternative logcat buffers reporting. They will use the same other arguments as those provided here.

See Listing of logcat Command Options.

Parameters:

logcatArguments - arguments to supply if retrieving the log as part of the report.

Returns:

this instance

setReportContent

@NonNull
public CoreConfigurationBuilder setReportContent(@NonNull
                                                          ReportField... reportContent)

Redefines the list of ReportFields collected and sent in your reports.

You can also use this property to modify fields order in your reports.

The default list is ACRAConstants.DEFAULT_REPORT_FIELDS

Parameters:

reportContent - fields to be included in the report.

Returns:

this instance

setDeleteUnapprovedReportsOnApplicationStart

@NonNull
public CoreConfigurationBuilder setDeleteUnapprovedReportsOnApplicationStart(boolean deleteUnapprovedReportsOnApplicationStart)

Controls whether unapproved reports are deleted on application start or not.

Silent and Toast reports are automatically approved. Dialog and Notification reports require explicit approval by the user before they are sent.

On application restart the user is prompted with approval for one unsent report. So you generally don't want to accumulate unapproved reports, otherwise you will prompt them multiple times.

If this is set to true then all unapproved reports bar one will be deleted on application start. The last report is always retained because that is the report that probably just happened.

Parameters:

deleteUnapprovedReportsOnApplicationStart - if ACRA should delete unapproved reports on application start.

Returns:

this instance

setDeleteOldUnsentReportsOnApplicationStart

@NonNull
public CoreConfigurationBuilder setDeleteOldUnsentReportsOnApplicationStart(boolean deleteOldUnsentReportsOnApplicationStart)

This property can be used to determine whether old (out of date) reports should be sent or not.

Parameters:

deleteOldUnsentReportsOnApplicationStart - if ACRA should delete any unsent reports on startup if the application has been updated since the last time the application was started.

Returns:

this instance

setAlsoReportToAndroidFramework

@NonNull
public CoreConfigurationBuilder setAlsoReportToAndroidFramework(boolean alsoReportToAndroidFramework)

Set this to true if you prefer displaying the native force close dialog after ACRA is done. Recommended: Keep this set to false if using interactions with user input.

Parameters:

alsoReportToAndroidFramework - if the native force close dialog should be displayed.

Returns:

this instance

setAdditionalSharedPreferences

@NonNull
public CoreConfigurationBuilder setAdditionalSharedPreferences(@NonNull
                                                                        String... additionalSharedPreferences)

Add here your SharedPreferences identifier Strings if you use others than your application's default. They will be added to the ReportField.SHARED_PREFERENCES field.

Parameters:

additionalSharedPreferences - names of additional preferences.

Returns:

this instance

setLogcatFilterByPid

@NonNull
public CoreConfigurationBuilder setLogcatFilterByPid(boolean logcatFilterByPid)

Set this to true if you want to include only logcat lines related to your Application process. Note that this is always done by android starting with API 16 (Jellybean)

Parameters:

logcatFilterByPid - true if you want to filter logcat with your process id.

Returns:

this instance

setLogcatReadNonBlocking

@NonNull
public CoreConfigurationBuilder setLogcatReadNonBlocking(boolean logcatReadNonBlocking)

Set this to true if you want to read logcat lines in a non blocking way for your thread. It has a default timeout of 3 seconds.

Parameters:

logcatReadNonBlocking - if reading of logcat lines should not block the current thread.

Returns:

this instance

setSendReportsInDevMode

@NonNull
public CoreConfigurationBuilder setSendReportsInDevMode(boolean sendReportsInDevMode)

Set this to false if you want to disable sending reports in development mode. Only signed application packages will send reports.

Parameters:

sendReportsInDevMode - if reports should only be sent from signed packages.

Returns:

this instance

setExcludeMatchingSharedPreferencesKeys

@NonNull
public CoreConfigurationBuilder setExcludeMatchingSharedPreferencesKeys(@NonNull
                                                                                 String... excludeMatchingSharedPreferencesKeys)

Provide here regex patterns to be evaluated on each SharedPreferences key to exclude KV pairs from the collected SharedPreferences. This allows you to exclude sensitive user data like passwords from being collected.

Parameters:

excludeMatchingSharedPreferencesKeys - regex patterns, every matching key is not collected.

Returns:

this instance

setExcludeMatchingSettingsKeys

@NonNull
public CoreConfigurationBuilder setExcludeMatchingSettingsKeys(@NonNull
                                                                        String... excludeMatchingSettingsKeys)

Provide here regex patterns to be evaluated on each Settings.System, Settings.Secure and Settings.Global key to exclude KV pairs from being collected. This allows you to exclude sensitive data from being collected.

Parameters:

excludeMatchingSettingsKeys - regex patterns, every matching key is not collected.

Returns:

this instance

setBuildConfigClass

@NonNull
public CoreConfigurationBuilder setBuildConfigClass(@NonNull
                                                             Class buildConfigClass)

The default value will be a BuildConfig class residing in the same package as the Application class. You only have to set this option if your BuildConfig class is obfuscated.

Parameters:

buildConfigClass - BuildConfig class from which to read any BuildConfig attributes.

Returns:

this instance

setReportSenderFactoryClasses

@Deprecated
 @NonNull
public CoreConfigurationBuilder setReportSenderFactoryClasses(@NonNull
                                                                                    Class<? extends ReportSenderFactory>... reportSenderFactoryClasses)

Deprecated. register with plugin loading instead

Parameters:

reportSenderFactoryClasses - ReportSenderFactorys with which to construct the ReportSenders that will send the crash reports.

Returns:

this instance

setApplicationLogFile

@NonNull
public CoreConfigurationBuilder setApplicationLogFile(@NonNull
                                                               String applicationLogFile)

To use in combination with ReportField.APPLICATION_LOG to set the path/name of your application log file.

Parameters:

applicationLogFile - path/name of your application log file.

Returns:

this instance

setApplicationLogFileLines

@NonNull
public CoreConfigurationBuilder setApplicationLogFileLines(int applicationLogFileLines)

To use in combination with ReportField.APPLICATION_LOG to set the number of latest lines of your application log file to be collected. Default value is 100.

Parameters:

applicationLogFileLines - number of lines to collect.

Returns:

this instance

setApplicationLogFileDir

@NonNull
public CoreConfigurationBuilder setApplicationLogFileDir(@NonNull
                                                                  Directory applicationLogFileDir)

To use in combination with ReportField.APPLICATION_LOG to set the root for the path provided in applicationLogFile()

Parameters:

applicationLogFileDir - the directory of the application log file

Returns:

this instance

setRetryPolicyClass

@NonNull
public CoreConfigurationBuilder setRetryPolicyClass(@NonNull
                                                             Class<? extends RetryPolicy> retryPolicyClass)

Implement a custom RetryPolicy to decide if a failed report should be resent or not.

Parameters:

retryPolicyClass - a class that decides if a report should be resent (usually if one or more senders failed).

Returns:

this instance

Since:

4.9.1

setStopServicesOnCrash

@NonNull
public CoreConfigurationBuilder setStopServicesOnCrash(boolean stopServicesOnCrash)

If you have services which might crash on startup android will try to restart them indefinitely. Set this to true to prevent that.

Parameters:

stopServicesOnCrash - if all services running in a process should be stopped before it is killed.

Returns:

this instance

Since:

4.9.2

setAttachmentUris

@NonNull
public CoreConfigurationBuilder setAttachmentUris(@NonNull
                                                           String... attachmentUris)

Allows to attach files to crash reports.

ACRA contains a file provider under the following Uri: content://[applicationId].acra/[Directory]/[Path] where [applicationId] is your application package name, [Directory] is one of the enum constants in Directory in lower case and [Path] is the relative path to the file in that directory e.g. content://org.acra.test.acra/files/thisIsATest.txt

Side effects:

• POST mode: requests will be sent with content-type multipart/form-data
• PUT mode: There will be additional requests with the attachments. Naming scheme: [report-id]-[filename]
• EMAIL mode: Some email clients do not support attachments, so some email may lack these attachments. Note that attachments might be readable to email clients when they are sent.

Parameters:

attachmentUris - uris to be attached to crash reports.

Returns:

this instance

Since:

4.9.3

setAttachmentUriProvider

@NonNull
public CoreConfigurationBuilder setAttachmentUriProvider(@NonNull
                                                                  Class<? extends AttachmentUriProvider> attachmentUriProvider)

Allows attachmentUris() configuration at runtime instead of compile time.

Parameters:

attachmentUriProvider - a class that decides which uris should be attached to reports

Returns:

this instance

Since:

4.9.3

setReportSendSuccessToast

@NonNull
public CoreConfigurationBuilder setReportSendSuccessToast(@Nullable
                                                                   String reportSendSuccessToast)

Toast shown when a report is sent successfully

Parameters:

reportSendSuccessToast - Resource id for the Toast text triggered when a report was sent successfully.

Returns:

this instance

Since:

5.0.0

setResReportSendSuccessToast

@NonNull
public CoreConfigurationBuilder setResReportSendSuccessToast(@StringRes
                                                                      int resReportSendSuccessToast)

Toast shown when a report is sent successfully

Parameters:

resReportSendSuccessToast - Resource id for the Toast text triggered when a report was sent successfully.

Returns:

this instance

Since:

5.0.0

setReportSendFailureToast

@NonNull
public CoreConfigurationBuilder setReportSendFailureToast(@Nullable
                                                                   String reportSendFailureToast)

Toast shown when report sending fails

Parameters:

reportSendFailureToast - Resource id for the Toast text triggered when no report was sent successfully.

Returns:

this instance

Since:

5.0.0

setResReportSendFailureToast

@NonNull
public CoreConfigurationBuilder setResReportSendFailureToast(@StringRes
                                                                      int resReportSendFailureToast)

Toast shown when report sending fails

Parameters:

resReportSendFailureToast - Resource id for the Toast text triggered when no report was sent successfully.

Returns:

this instance

Since:

5.0.0

setReportFormat

@NonNull
public CoreConfigurationBuilder setReportFormat(@NonNull
                                                         StringFormat reportFormat)

Format in which the report should be sent

Parameters:

reportFormat - report format

Returns:

this instance

Since:

5.0.0

setParallel

@NonNull
public CoreConfigurationBuilder setParallel(boolean parallel)

Allow parallel collection. Increases performance but might pollute e.g. logcat output

Parameters:

parallel - if parallel collection should be active

Returns:

this instance

Since:

5.0.1

setPluginLoader

@NonNull
public CoreConfigurationBuilder setPluginLoader(PluginLoader pluginLoader)

Set a custom plugin loader. Note: Call this before any call to getPluginConfigurationBuilder(Class)

Parameters:

pluginLoader - the custom implementation

Returns:

this instance

setReportField

@NonNull
public CoreConfigurationBuilder setReportField(ReportField field,
                                                        boolean enable)

Use this if you want to keep the default configuration of reportContent, but set some fields explicitly.

Parameters:

field - the field to set

enable - if this field should be reported

Returns:

this instance

getPluginConfigurationBuilder

@NonNull
public <R extends ConfigurationBuilder> R getPluginConfigurationBuilder(Class<R> c)

build

@NonNull
public CoreConfiguration build()
                                 throws ACRAConfigurationException

Description copied from interface: ConfigurationBuilder

Builds the configuration

Specified by:

build in interface ConfigurationBuilder

Returns:

the fully configured and immutable configuration

Throws:

ACRAConfigurationException - if the configuration is invalid