com.pubmatic.sdk.common.base

Class PMCommunicator<AdDescriptorType>

java.lang.Object

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

Type Parameters:

AdDescriptorType - Type of descriptor expected from PMCommunicatorListener callback.

All Implemented Interfaces:

PMAdBuilding.PMAdBuilderListener<AdDescriptorType>, PMNetworkHandler.PMNetworkListener<org.json.JSONObject>, PMResponseParsing.PMResponseParserListener

public class PMCommunicator<AdDescriptorType>
extends java.lang.Object
implements PMNetworkHandler.PMNetworkListener<org.json.JSONObject>, PMResponseParsing.PMResponseParserListener, PMAdBuilding.PMAdBuilderListener<AdDescriptorType>

Class to handle the communication between the network layer and the UI layer. It forms the request using PMRequestBuilding, makes network call using PMNetworkHandler, parses response using PMResponseParsing and finally format the parsed response using the PMAdBuilding instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PMCommunicator.PMCommunicatorListener<AdDescriptorType> Interface to get the callback from PMCommunicator

Constructor Summary

Constructors

Constructor and Description
PMCommunicator(PMRequestBuilding requestBuilder, PMResponseParsing responseParser, PMAdBuilding<AdDescriptorType> adBuilder, PMNetworkHandler networkHandler) Constructor

Method Summary

Modifier and Type	Method and Description
void	adBuilderOnError(POBError error)
void	adBuilderOnSuccess(java.util.List<AdDescriptorType> adDescriptor)
void	cancel() Cancels any outstanding network call.
void	onFailure(POBError error)
void	onSuccess(org.json.JSONObject response) Called when a response is received.
void	parserOnError(POBError error)
void	parserOnSuccess(PMAdResponse adResponse)
void	requestAd() Request an ad.
void	setListener(PMCommunicator.PMCommunicatorListener<AdDescriptorType> listener) Sets the listener to get the callback

Methods inherited from class java.lang.Object

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

Constructor Detail

PMCommunicator

public PMCommunicator(@NonNull
                      PMRequestBuilding requestBuilder,
                      @NonNull
                      PMResponseParsing responseParser,
                      @NonNull
                      PMAdBuilding<AdDescriptorType> adBuilder,
                      @NonNull
                      PMNetworkHandler networkHandler)

Constructor

Parameters:

requestBuilder - PMRequestBuilding instance to forms the request

responseParser - PMResponseParsing instance to parse response

adBuilder - PMAdBuilding instance to format the parsed response

networkHandler - PMNetworkHandler instance to make a network call

Method Detail

setListener

public void setListener(PMCommunicator.PMCommunicatorListener<AdDescriptorType> listener)

Sets the listener to get the callback

Parameters:

listener - The listener object to get the callback

requestAd

public void requestAd()

Request an ad.

cancel

public void cancel()

Cancels any outstanding network call.

adBuilderOnSuccess

public void adBuilderOnSuccess(@NonNull
                               java.util.List<AdDescriptorType> adDescriptor)

Specified by:

adBuilderOnSuccess in interface PMAdBuilding.PMAdBuilderListener<AdDescriptorType>

adBuilderOnError

public void adBuilderOnError(@NonNull
                             POBError error)

Specified by:

adBuilderOnError in interface PMAdBuilding.PMAdBuilderListener<AdDescriptorType>

parserOnSuccess

public void parserOnSuccess(@NonNull
                            PMAdResponse adResponse)

Specified by:

parserOnSuccess in interface PMResponseParsing.PMResponseParserListener

parserOnError

public void parserOnError(@NonNull
                          POBError error)

Specified by:

parserOnError in interface PMResponseParsing.PMResponseParserListener

onSuccess

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

Description copied from interface: PMNetworkHandler.PMNetworkListener

Called when a response is received.

Specified by:

onSuccess in interface PMNetworkHandler.PMNetworkListener<org.json.JSONObject>

Parameters:

response - of generic type

onFailure

public void onFailure(@NonNull
                      POBError error)

Specified by:

onFailure in interface PMNetworkHandler.PMNetworkListener<org.json.JSONObject>

Parameters:

error - Error object