com.pubmatic.sdk.common.base

Class POBCommunicator<AdDescriptorType extends POBAdDescriptor>

java.lang.Object

com.pubmatic.sdk.common.base.POBCommunicator<AdDescriptorType>

Type Parameters:

AdDescriptorType - Type of descriptor expected from POBCommunicator.POBCommunicatorListener callback.

All Implemented Interfaces:

POBAdBuilding.POBAdBuilderListener<AdDescriptorType>, POBResponseParsing.POBResponseParserListener<AdDescriptorType>, POBNetworkHandler.POBNetworkListener<org.json.JSONObject>, POBNetworkHandler.POBNetworkResultListener

public class POBCommunicator<AdDescriptorType extends POBAdDescriptor>
extends java.lang.Object
implements POBNetworkHandler.POBNetworkListener<org.json.JSONObject>, POBResponseParsing.POBResponseParserListener<AdDescriptorType>, POBAdBuilding.POBAdBuilderListener<AdDescriptorType>, POBNetworkHandler.POBNetworkResultListener

Class to handle the communication between the network layer and the UI layer. It forms the request using POBRequestBuilding, makes network call using POBNetworkHandler, parses response using POBResponseParsing and finally format the parsed response using the POBAdBuilding instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	POBCommunicator.POBCommunicatorListener<AdDescriptorType extends POBAdDescriptor> Interface to get the callback from POBCommunicator
static interface	POBCommunicator.POBErrorCustomisationListener Interface definition provides error to be update by client class of the Communicator.

Constructor Summary

Constructors

Constructor and Description
POBCommunicator(POBRequestBuilding requestBuilder, POBResponseParsing responseParser, POBAdBuilding<AdDescriptorType> adBuilder, POBNetworkHandler networkHandler) Constructor

Method Summary

Modifier and Type	Method and Description
void	adBuilderOnSuccess(POBAdResponse<AdDescriptorType> adDescriptor)
void	cancel() Cancels any outstanding network call.
POBNetworkResult	getNetworkResult() To get network result of the request, this will available only after making request call
void	onFailure(POBError error) Called when request is failed
void	onResult(POBNetworkResult result) Notify network result before notifying success or failure
void	onSuccess(org.json.JSONObject response) Called when a response is received.
void	parserOnError(POBError error) Notifies with the error object when the parsing is failure
void	parserOnSuccess(POBAdResponse<AdDescriptorType> adResponse) Notifies with the parsed object when the parsing is success
void	requestAd() Request an ad.
void	setListener(POBCommunicator.POBCommunicatorListener<AdDescriptorType> listener) Sets the listener to get the callback
void	setPOBErrorCustomisationListener(POBCommunicator.POBErrorCustomisationListener pobErrorCustomisationListener) Set the custom error listener to get customised error, this can be implemented by the client class to provide customized error to communicator.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBCommunicator

public POBCommunicator(@NonNull
                       POBRequestBuilding requestBuilder,
                       @NonNull
                       POBResponseParsing responseParser,
                       @NonNull
                       POBAdBuilding<AdDescriptorType> adBuilder,
                       @NonNull
                       POBNetworkHandler networkHandler)

Constructor

Parameters:

requestBuilder - POBRequestBuilding instance to forms the request

responseParser - POBResponseParsing instance to parse response

adBuilder - POBAdBuilding instance to format the parsed response

networkHandler - POBNetworkHandler instance to make a network call

Method Detail

setListener

public void setListener(POBCommunicator.POBCommunicatorListener<AdDescriptorType> listener)

Sets the listener to get the callback

Parameters:

listener - The listener object to get the callback

setPOBErrorCustomisationListener

public void setPOBErrorCustomisationListener(@Nullable
                                             POBCommunicator.POBErrorCustomisationListener pobErrorCustomisationListener)

Set the custom error listener to get customised error, this can be implemented by the client class to provide customized error to communicator.

Parameters:

pobErrorCustomisationListener - the reference of custom error listener

requestAd

public void requestAd()

Request an ad.

cancel

public void cancel()

Cancels any outstanding network call.

adBuilderOnSuccess

public void adBuilderOnSuccess(@NonNull
                               POBAdResponse<AdDescriptorType> adDescriptor)

Specified by:

adBuilderOnSuccess in interface POBAdBuilding.POBAdBuilderListener<AdDescriptorType extends POBAdDescriptor>

parserOnSuccess

public void parserOnSuccess(@NonNull
                            POBAdResponse<AdDescriptorType> adResponse)

Description copied from interface: POBResponseParsing.POBResponseParserListener

Notifies with the parsed object when the parsing is success

Specified by:

parserOnSuccess in interface POBResponseParsing.POBResponseParserListener<AdDescriptorType extends POBAdDescriptor>

Parameters:

adResponse - Instance of the response class

parserOnError

public void parserOnError(@NonNull
                          POBError error)

Description copied from interface: POBResponseParsing.POBResponseParserListener

Notifies with the error object when the parsing is failure

Specified by:

parserOnError in interface POBResponseParsing.POBResponseParserListener<AdDescriptorType extends POBAdDescriptor>

Parameters:

error - Error instance

onSuccess

public void onSuccess(@Nullable
                      org.json.JSONObject response)

Description copied from interface: POBNetworkHandler.POBNetworkListener

Called when a response is received.

Specified by:

onSuccess in interface POBNetworkHandler.POBNetworkListener<org.json.JSONObject>

Parameters:

response - of generic type

onFailure

public void onFailure(@NonNull
                      POBError error)

Description copied from interface: POBNetworkHandler.POBNetworkListener

Called when request is failed

Specified by:

onFailure in interface POBNetworkHandler.POBNetworkListener<org.json.JSONObject>

Parameters:

error - Error object

onResult

public void onResult(@Nullable
                     POBNetworkResult result)

Description copied from interface: POBNetworkHandler.POBNetworkResultListener

Notify network result before notifying success or failure

Specified by:

onResult in interface POBNetworkHandler.POBNetworkResultListener

Parameters:

result - the result to get network result

getNetworkResult

@Nullable
public POBNetworkResult getNetworkResult()

To get network result of the request, this will available only after making request call

Returns:

the network result of the request