io.branch.referral.network

Class BranchRemoteInterface

java.lang.Object

io.branch.referral.network.BranchRemoteInterface

Direct Known Subclasses:

BranchRemoteInterfaceUrlConnection

public abstract class BranchRemoteInterface
extends java.lang.Object

Abstract class for Branch remote interface. This class provides the abstraction layer for network operations between Branch SDK and remote Branch servers. Extend this class for creating custom network interface. Class provide abstract method for implementing RESTful requests to Branch server see doRestfulGet(String) doRestfulPost(String, JSONObject) BranchRemoteInterface.BranchResponse BranchRemoteInterface.BranchRemoteException

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BranchRemoteInterface.BranchRemoteException Exception thrown when there is an error while doing a restful operation with Branch Remote server see doRestfulGet(String) and doRestfulPost(String, JSONObject)
static class	BranchRemoteInterface.BranchResponse Class for providing result of RESTful operation against Branch Remote server

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RETRY_NUMBER Key for adding retry numbers for the request.

Constructor Summary

Constructors

Constructor and Description
BranchRemoteInterface()

Method Summary

Modifier and Type	Method and Description
abstract BranchRemoteInterface.BranchResponse	doRestfulGet(java.lang.String url) Abstract method to implement the network layer to do a RESTful GET to Branch servers.
abstract BranchRemoteInterface.BranchResponse	doRestfulPost(java.lang.String url, org.json.JSONObject payload) Abstract method to implement the network layer to do a RESTful GET to Branch servers.
static BranchRemoteInterface	getDefaultBranchRemoteInterface(android.content.Context context)
ServerResponse	make_restful_get(java.lang.String url, org.json.JSONObject params, java.lang.String tag, java.lang.String branchKey) Method for handling the RESTful POST operations to Branch Servers.
ServerResponse	make_restful_post(org.json.JSONObject body, java.lang.String url, java.lang.String tag, java.lang.String branchKey) Method for handling the RESTful POST operations to Branch Servers.

Methods inherited from class java.lang.Object

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

Field Detail

RETRY_NUMBER

public static final java.lang.String RETRY_NUMBER

Key for adding retry numbers for the request. This will help better network issue analysis and debugging. Add the retry number to the GET Request as a query param and as a JSon key value for post

See Also:

Constant Field Values

Constructor Detail

BranchRemoteInterface

public BranchRemoteInterface()

Method Detail

doRestfulGet

public abstract BranchRemoteInterface.BranchResponse doRestfulGet(java.lang.String url)
                                                           throws BranchRemoteInterface.BranchRemoteException

Abstract method to implement the network layer to do a RESTful GET to Branch servers. This method is called whenever Branch SDK want to make a GET request to Branch servers. Please note that this methods always called on the background thread and no need for thread switching for the network operations.

Parameters:

url - The url end point

Returns:

BranchRemoteInterface.BranchResponse with the get result data and http status code

Throws:

BranchRemoteInterface.BranchRemoteException - Branch remote exception is thrown when there is an error in communicating to the Branch servers BranchRemoteException contains the corresponding BranchError code for the error BranchError.ERR_BRANCH_NO_CONNECTIVITY | BranchError.ERR_BRANCH_REQ_TIMED_OUT see BranchRemoteInterface.BranchRemoteException BranchRemoteInterface.BranchResponse NOTE: For better debugging purpose conside adding RETRY_NUMBER as a query params if you implement multiple retries for your request

doRestfulPost

public abstract BranchRemoteInterface.BranchResponse doRestfulPost(java.lang.String url,
                                                                   org.json.JSONObject payload)
                                                            throws BranchRemoteInterface.BranchRemoteException

Abstract method to implement the network layer to do a RESTful GET to Branch servers. This method is called whenever Branch SDK want to make a GET request to Branch servers. Please note that this methods always called on the background thread and no need for thread switching to execute network operations.

Parameters:

url - The url end point

payload - The JSon object payload for the post request

Returns:

BranchRemoteInterface.BranchResponse with the get result data and http status code

Throws:

BranchRemoteInterface.BranchRemoteException - Branch remote exception is thrown when there is an error in communicating to the Branch servers BranchRemoteException contains the corresponding BranchError code for the error BranchError.ERR_BRANCH_NO_CONNECTIVITY | BranchError.ERR_BRANCH_REQ_TIMED_OUT see BranchRemoteInterface.BranchRemoteException BranchRemoteInterface.BranchResponse NOTE: For better debugging purpose conside adding RETRY_NUMBER as a JSon keyvalue if you implement multiple retries for your request

make_restful_get

public final ServerResponse make_restful_get(java.lang.String url,
                                             org.json.JSONObject params,
                                             java.lang.String tag,
                                             java.lang.String branchKey)

Method for handling the RESTful POST operations to Branch Servers. Internally calls abstract method doRestfulGet(String)

Parameters:

url - The url end point

params - with parameters to the GET call

tag - String Tag for identifying the request for analytical or debugging purpose

branchKey - String Branch key

Returns:

ServerResponse object representing the result of RESTful GET to Branch Server

make_restful_post

public final ServerResponse make_restful_post(org.json.JSONObject body,
                                              java.lang.String url,
                                              java.lang.String tag,
                                              java.lang.String branchKey)

Method for handling the RESTful POST operations to Branch Servers. Internally calls abstract method doRestfulPost(String, JSONObject)

Parameters:

url - The url end point

body - with parameters to the POST call

tag - String Tag for identifying the request for analytical or debugging purpose

branchKey - String Branch key

Returns:

ServerResponse object representing the result of RESTful POST to Branch Server

getDefaultBranchRemoteInterface

public static final BranchRemoteInterface getDefaultBranchRemoteInterface(android.content.Context context)