org.acra.sender

Class HttpSender

java.lang.Object

org.acra.sender.HttpSender

All Implemented Interfaces:

ReportSender

public class HttpSender
extends Object
implements ReportSender

The ReportSender used by ACRA when ReportsCrashes.formUri() has been defined in order to post crash data to a custom server-side data collection script. It sends all data in a POST request with parameters named with easy to understand names (basically a string conversion of ReportField enum values) or based on your own conversion Map from ReportField values to String.

To use specific POST parameter names, you can provide your own report fields mapping scheme:

 Just create and declare a ReportSenderFactory that constructs a mapping
 from each ReportField to another name.
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpSender.Method Available HTTP methods to send data.
static class	HttpSender.Type Type of report data encoding, currently supports Html Form encoding and JSON.

Constructor Summary

Constructors

Constructor and Description
HttpSender(ACRAConfiguration config, HttpSender.Method method, HttpSender.Type type, Map<ReportField,String> mapping) Create a new HttpSender instance with its destination taken from the supplied config.
HttpSender(ACRAConfiguration config, HttpSender.Method method, HttpSender.Type type, String formUri, Map<ReportField,String> mapping) Create a new HttpPostSender instance with a fixed destination provided as a parameter.

Method Summary

Methods

Modifier and Type	Method and Description
void	send(android.content.Context context, CrashReportData report) Send crash report data.
void	setBasicAuth(String username, String password) Set credentials for this HttpSender that override (if present) the ones set globally.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpSender

public HttpSender(@NonNull
          ACRAConfiguration config,
          @NonNull
          HttpSender.Method method,
          @NonNull
          HttpSender.Type type,
          @Nullable
          Map<ReportField,String> mapping)

Create a new HttpSender instance with its destination taken from the supplied config.

Parameters:

config - AcraConfig declaring the

method - HTTP HttpSender.Method to be used to send data. Currently only HttpSender.Method.POST and HttpSender.Method.PUT are available. If HttpSender.Method.PUT is used, the ReportField.REPORT_ID is appended to the formUri to be compliant with RESTful APIs.

type - HttpSender.Type of encoding used to send the report body. HttpSender.Type.FORM is a simple Key/Value pairs list as defined by the application/x-www-form-urlencoded mime type.

mapping - Applies only to HttpSender.Method.POST method parameter. If null, POST parameters will be named with ReportField values converted to String with .toString(). If not null, POST parameters will be named with the result of mapping.get(ReportField.SOME_FIELD);

HttpSender

public HttpSender(@NonNull
          ACRAConfiguration config,
          @NonNull
          HttpSender.Method method,
          @NonNull
          HttpSender.Type type,
          @Nullable
          String formUri,
          @Nullable
          Map<ReportField,String> mapping)

Create a new HttpPostSender instance with a fixed destination provided as a parameter. Configuration changes to the formUri are not applied.

Parameters:

config - AcraConfig declaring the

method - HTTP HttpSender.Method to be used to send data. Currently only HttpSender.Method.POST and HttpSender.Method.PUT are available. If HttpSender.Method.PUT is used, the ReportField.REPORT_ID is appended to the formUri to be compliant with RESTful APIs.

type - HttpSender.Type of encoding used to send the report body. HttpSender.Type.FORM is a simple Key/Value pairs list as defined by the application/x-www-form-urlencoded mime type.

formUri - The URL of your server-side crash report collection script.

mapping - Applies only to HttpSender.Method.POST method parameter. If null, POST parameters will be named with ReportField values converted to String with .toString(). If not null, POST parameters will be named with the result of mapping.get(ReportField.SOME_FIELD);

Method Detail

setBasicAuth

public void setBasicAuth(@Nullable
                String username,
                @Nullable
                String password)

Set credentials for this HttpSender that override (if present) the ones set globally.

Parameters:

username - The username to set for HTTP Basic Auth.

password - The password to set for HTTP Basic Auth.

send

public void send(@NonNull
        android.content.Context context,
        @NonNull
        CrashReportData report)
          throws ReportSenderException

Description copied from interface: ReportSender

Send crash report data. Method will be called from the SenderService.

Specified by:

send in interface ReportSender

Parameters:

context - Android Context in which to send the crash report.

report - Stores key/value pairs for each report field. A report field is identified by a ReportField enum value.

Throws:

ReportSenderException - If anything goes fatally wrong during the handling of crash data, you can (should) throw a ReportSenderException with a custom message.