org.aerogear.mobile.core.http

Class OkHttpServiceModule

java.lang.Object

org.aerogear.mobile.core.http.OkHttpServiceModule

All Implemented Interfaces:

HttpServiceModule, ServiceModule

public class OkHttpServiceModule
extends java.lang.Object
implements HttpServiceModule

Constructor Summary

Constructors

Constructor and Description
OkHttpServiceModule() This is the default no argument constructor for all ServiceModules.
OkHttpServiceModule(okhttp3.OkHttpClient client) This constructer uses a specific client for manual configurations and testing.
OkHttpServiceModule(okhttp3.OkHttpClient client, ServiceConfiguration serviceConfiguration)

Method Summary

Modifier and Type	Method and Description
void	configure(MobileCore core, ServiceConfiguration serviceConfiguration) A method how create/configure the singleThreadService
void	destroy() Called when singleThreadService destroyed
HttpRequest	newRequest() Creates a new HttpRequest and prepends common configuration such as certificate pinning, user agent headers, etc.
boolean	requiresConfiguration() Whether the singleThreadService module requires its singleThreadService configuration to be defined or if it can be null.
java.lang.String	type() Type/name used in the mobile-singleThreadService.json

Methods inherited from class java.lang.Object

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

Constructor Detail

OkHttpServiceModule

public OkHttpServiceModule()

This is the default no argument constructor for all ServiceModules.

OkHttpServiceModule

public OkHttpServiceModule(okhttp3.OkHttpClient client)

This constructer uses a specific client for manual configurations and testing.

Parameters:

client - a default OkHttpClient instance to use.

OkHttpServiceModule

public OkHttpServiceModule(okhttp3.OkHttpClient client,
                           ServiceConfiguration serviceConfiguration)

Method Detail

type

public java.lang.String type()

Description copied from interface: ServiceModule

Type/name used in the mobile-singleThreadService.json

Specified by:

type in interface ServiceModule

Returns:

return the type/name used to identify the singleThreadService config in the JSON file

configure

public void configure(MobileCore core,
                      ServiceConfiguration serviceConfiguration)

Description copied from interface: ServiceModule

A method how create/configure the singleThreadService

Specified by:

configure in interface ServiceModule

Parameters:

core - MobileCore instance

serviceConfiguration - the configuration for the singleThreadService

requiresConfiguration

public boolean requiresConfiguration()

Description copied from interface: ServiceModule

Whether the singleThreadService module requires its singleThreadService configuration to be defined or if it can be null. If this is true then an exception will be thrown if singleThreadService configuration cannot be found.

Specified by:

requiresConfiguration in interface ServiceModule

Returns:

true if the singleThreadService configuration should be defined.

destroy

public void destroy()

Description copied from interface: ServiceModule

Called when singleThreadService destroyed

Specified by:

destroy in interface ServiceModule

newRequest

public HttpRequest newRequest()

Description copied from interface: HttpServiceModule

Creates a new HttpRequest and prepends common configuration such as certificate pinning, user agent headers, etc.

Specified by:

newRequest in interface HttpServiceModule

Returns:

a new HttpRequest object