org.acra.annotation

Annotation Type AcraHttpSender

@Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Inherited
public @interface AcraHttpSender

Http sender configuration

Since:

01.06.2017

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
HttpSender.Method	httpMethod The HttpSender.Method to be used when posting with uri() .
String	uri The Uri of your own server-side script that will receive reports.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	basicAuthLogin you can set here and in basicAuthPassword() the credentials for a BASIC HTTP authentication.
String	basicAuthPassword you can set here and in basicAuthLogin() the credentials for a BASIC HTTP authentication.
String	certificatePath a certificate used for ssl authentication
String	certificateType type of the certificate used for ssl authentication
boolean	compress if the server request should be compressed using gzip
int	connectionTimeout timeout for server connection
boolean	dropReportsOnTimeout allows to prevent resending of timed out reports, possibly relieving server stress, but also reducing received report counts
Class<? extends KeyStoreFactory>	keyStoreFactoryClass A custom class supplying a KeyStore, which will be used for ssl authentication.
int	resCertificate a certificate used for ssl authentication
int	socketTimeout timeout for socket connection

Element Detail

uri

@NonNull
public abstract String uri

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

Returns:

URI of a server to which to send reports.

Since:

5.0.0

httpMethod

@NonNull
public abstract HttpSender.Method httpMethod

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

Returns:

HTTP method used when posting reports.

Since:

5.0.0

basicAuthLogin

@NonNull
public abstract String basicAuthLogin

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

Returns:

Login to use.

Since:

5.0.0

Default:

"ACRA-NULL-STRING"

basicAuthPassword

@NonNull
public abstract String basicAuthPassword

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

Returns:

Password to use.

Since:

5.0.0

Default:

"ACRA-NULL-STRING"

connectionTimeout

public abstract int connectionTimeout

timeout for server connection

Returns:

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

Since:

5.0.0

See Also:

URLConnection.setConnectTimeout(int)

Default:

5000

socketTimeout

public abstract int socketTimeout

timeout for socket connection

Returns:

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

Since:

5.0.0

See Also:

URLConnection.setReadTimeout(int)

Default:

20000

dropReportsOnTimeout

public abstract boolean dropReportsOnTimeout

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

Returns:

if timed out reports should be dropped

Since:

5.0.0

Default:

false

keyStoreFactoryClass

@NonNull
public abstract Class<? extends KeyStoreFactory> keyStoreFactoryClass

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

Returns:

Class which creates a keystore that can contain trusted certificates

Since:

5.0.0

Default:

org.acra.security.NoKeyStoreFactory.class

certificatePath

@NonNull
public abstract String certificatePath

a certificate used for ssl authentication

Returns:

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

Since:

5.0.0

Default:

""

resCertificate

@RawRes
public abstract int resCertificate

a certificate used for ssl authentication

Returns:

resource id of a custom trusted certificate.

Since:

5.0.0

Default:

0

certificateType

@NonNull
public abstract String certificateType

type of the certificate used for ssl authentication

Returns:

specify the type of the certificate set in either certificatePath() or resCertificate()

Since:

5.0.0

Default:

"X.509"

compress

public abstract boolean compress

if the server request should be compressed using gzip

Returns:

if compression should be active

Since:

5.2.0

Default:

false