io.branch.referral.network

Class BranchRemoteInterfaceUrlConnection

java.lang.Object

io.branch.referral.network.BranchRemoteInterface

io.branch.referral.network.BranchRemoteInterfaceUrlConnection

public class BranchRemoteInterfaceUrlConnection
extends BranchRemoteInterface

Created by sojanpr on 5/31/17. Class for implementing BranchRemoteInterface using the HttpUrlConnection. This class provides implementation for Branch RESTful operations using HTTP URL Connection.

Nested Class Summary

Nested classes/interfaces inherited from class io.branch.referral.network.BranchRemoteInterface

BranchRemoteInterface.BranchRemoteException, BranchRemoteInterface.BranchResponse

Field Summary

Fields inherited from class io.branch.referral.network.BranchRemoteInterface

RETRY_NUMBER

Method Summary

Modifier and Type	Method and Description
BranchRemoteInterface.BranchResponse	doRestfulGet(java.lang.String url) Abstract method to implement the network layer to do a RESTful GET to Branch servers.
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.

Methods inherited from class io.branch.referral.network.BranchRemoteInterface

getDefaultBranchRemoteInterface, make_restful_get, make_restful_post

Methods inherited from class java.lang.Object

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

Method Detail

doRestfulGet

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

Description copied from class: BranchRemoteInterface

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.

Specified by:

doRestfulGet in class BranchRemoteInterface

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 BranchRemoteInterface.RETRY_NUMBER as a query params if you implement multiple retries for your request

doRestfulPost

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

Description copied from class: BranchRemoteInterface

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.

Specified by:

doRestfulPost in class BranchRemoteInterface

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 BranchRemoteInterface.RETRY_NUMBER as a JSon keyvalue if you implement multiple retries for your request