org.acra.config

Interface HttpSenderConfigurationBuilder

All Superinterfaces:

ConfigurationBuilder

public interface HttpSenderConfigurationBuilder
extends ConfigurationBuilder

Class generated based on AcraHttpSender (18.03.2020 16:20:26)

Method Summary

Modifier and Type	Method and Description
HttpSenderConfigurationBuilder	setBasicAuthLogin(String basicAuthLogin) you can set here and in AcraHttpSender.basicAuthPassword() the credentials for a BASIC HTTP authentication.
HttpSenderConfigurationBuilder	setBasicAuthPassword(String basicAuthPassword) you can set here and in AcraHttpSender.basicAuthLogin() the credentials for a BASIC HTTP authentication.
HttpSenderConfigurationBuilder	setCertificatePath(String certificatePath) a certificate used for ssl authentication
HttpSenderConfigurationBuilder	setCertificateType(String certificateType) type of the certificate used for ssl authentication
HttpSenderConfigurationBuilder	setCompress(boolean compress) if the server request should be compressed using gzip
HttpSenderConfigurationBuilder	setConnectionTimeout(int connectionTimeout) timeout for server connection
HttpSenderConfigurationBuilder	setDropReportsOnTimeout(boolean dropReportsOnTimeout) allows to prevent resending of timed out reports, possibly relieving server stress, but also reducing received report counts
HttpSenderConfigurationBuilder	setEnabled(boolean enabled)
HttpSenderConfigurationBuilder	setHttpHeaders(Map<String,String> headers) Set custom HTTP headers to be sent by the provided HttpSender This should be used also by third party senders.
HttpSenderConfigurationBuilder	setHttpMethod(HttpSender.Method httpMethod) The HttpSender.Method to be used when posting with AcraHttpSender.uri() .
HttpSenderConfigurationBuilder	setKeyStoreFactoryClass(Class<? extends KeyStoreFactory> keyStoreFactoryClass) A custom class supplying a KeyStore, which will be used for ssl authentication.
HttpSenderConfigurationBuilder	setResCertificate(int resCertificate) a certificate used for ssl authentication
HttpSenderConfigurationBuilder	setSocketTimeout(int socketTimeout) timeout for socket connection
HttpSenderConfigurationBuilder	setUri(String uri) The Uri of your own server-side script that will receive reports.

Methods inherited from interface org.acra.config.ConfigurationBuilder

build

Method Detail

setEnabled

@NonNull
HttpSenderConfigurationBuilder setEnabled(boolean enabled)

setUri

@NonNull
HttpSenderConfigurationBuilder setUri(@NonNull
                                               String uri)

The Uri of your own server-side script that will receive reports.

Parameters:

uri - URI of a server to which to send reports.

Returns:

this instance

Since:

5.0.0

setBasicAuthLogin

@NonNull
HttpSenderConfigurationBuilder setBasicAuthLogin(@NonNull
                                                          String basicAuthLogin)

you can set here and in AcraHttpSender.basicAuthPassword() the credentials for a BASIC HTTP authentication.

Parameters:

basicAuthLogin - Login to use.

Returns:

this instance

Since:

5.0.0

setBasicAuthPassword

@NonNull
HttpSenderConfigurationBuilder setBasicAuthPassword(@NonNull
                                                             String basicAuthPassword)

you can set here and in AcraHttpSender.basicAuthLogin() the credentials for a BASIC HTTP authentication.

Parameters:

basicAuthPassword - Password to use.

Returns:

this instance

Since:

5.0.0

setHttpMethod

@NonNull
HttpSenderConfigurationBuilder setHttpMethod(@NonNull
                                                      HttpSender.Method httpMethod)

The HttpSender.Method to be used when posting with AcraHttpSender.uri() .

Parameters:

httpMethod - HTTP method used when posting reports.

Returns:

this instance

Since:

5.0.0

setConnectionTimeout

@NonNull
HttpSenderConfigurationBuilder setConnectionTimeout(int connectionTimeout)

timeout for server connection

Parameters:

connectionTimeout - Value in milliseconds for timeout attempting to connect to a network.

Returns:

this instance

Since:

5.0.0

See Also:

URLConnection.setConnectTimeout(int)

setSocketTimeout

@NonNull
HttpSenderConfigurationBuilder setSocketTimeout(int socketTimeout)

timeout for socket connection

Parameters:

socketTimeout - Value in milliseconds for timeout receiving a response to a network request.

Returns:

this instance

Since:

5.0.0

See Also:

URLConnection.setReadTimeout(int)

setDropReportsOnTimeout

@NonNull
HttpSenderConfigurationBuilder setDropReportsOnTimeout(boolean dropReportsOnTimeout)

allows to prevent resending of timed out reports, possibly relieving server stress, but also reducing received report counts

Parameters:

dropReportsOnTimeout - if timed out reports should be dropped

Returns:

this instance

Since:

5.0.0

setKeyStoreFactoryClass

@NonNull
HttpSenderConfigurationBuilder setKeyStoreFactoryClass(@NonNull
                                                                Class<? extends KeyStoreFactory> keyStoreFactoryClass)

A custom class supplying a KeyStore, which will be used for ssl authentication. A base implementation is available: BaseKeyStoreFactory

Parameters:

keyStoreFactoryClass - Class which creates a keystore that can contain trusted certificates

Returns:

this instance

Since:

5.0.0

setCertificatePath

@NonNull
HttpSenderConfigurationBuilder setCertificatePath(@NonNull
                                                           String certificatePath)

a certificate used for ssl authentication

Parameters:

certificatePath - path to a custom trusted certificate. Must start with "asset://" if the file is in the assets folder

Returns:

this instance

Since:

5.0.0

setResCertificate

@NonNull
HttpSenderConfigurationBuilder setResCertificate(@RawRes
                                                          int resCertificate)

a certificate used for ssl authentication

Parameters:

resCertificate - resource id of a custom trusted certificate.

Returns:

this instance

Since:

5.0.0

setCertificateType

@NonNull
HttpSenderConfigurationBuilder setCertificateType(@NonNull
                                                           String certificateType)

type of the certificate used for ssl authentication

Parameters:

certificateType - specify the type of the certificate set in either AcraHttpSender.certificatePath() or AcraHttpSender.resCertificate()

Returns:

this instance

Since:

5.0.0

setCompress

@NonNull
HttpSenderConfigurationBuilder setCompress(boolean compress)

if the server request should be compressed using gzip

Parameters:

compress - if compression should be active

Returns:

this instance

Since:

5.2.0

setHttpHeaders

@NonNull
HttpSenderConfigurationBuilder setHttpHeaders(Map<String,String> headers)

Set custom HTTP headers to be sent by the provided HttpSender This should be used also by third party senders.

Parameters:

headers - A map associating HTTP header names to their values.

Returns:

this instance