com.pubmatic.sdk.common.network

Class POBTrackerHandler

java.lang.Object

com.pubmatic.sdk.common.network.POBTrackerHandler

public class POBTrackerHandler
extends java.lang.Object

PMTrackerHandler class is used to handle Ad tracker

Constructor Summary

Constructors

Constructor and Description
POBTrackerHandler(POBNetworkHandler networkHandler)

Method Summary

Modifier and Type	Method and Description
void	executeJsScripts(POBWebView webView, java.lang.String htmlContent) Function used to execute the list of script tags or url of js files.
void	handleTrackersForError(java.util.List<java.lang.String> urls, java.util.Map<java.lang.Object,java.lang.Object> macroMap, java.util.Map<java.lang.String,java.lang.String> queryMap) Executes tracker urls with macro map in loop and appends query params to pubmatic tracker urls
static java.util.List<java.lang.String>	sanitizeURLScheme(java.util.List<java.lang.String> urls, boolean isSecure) Sanitize URLs by adding scheme/protocol to urls if not exist already.
static java.lang.String	sanitizeURLScheme(java.lang.String url, boolean isSecure) Sanitize URL by adding scheme/protocol to url if not exist already.
void	sendTracker(java.lang.String url) Method is used to send/fir tracker after validating success
void	sendTracker(java.lang.String url, java.util.Map<java.lang.Object,java.lang.Object> macroMap) Replace the macro in the given tracker URL.
void	sendTracker(java.lang.String url, java.lang.String regex, java.lang.String replacement)
void	sendTrackers(java.util.List<java.lang.String> urls) Method is used to send/fire tracker multiple url
void	sendTrackers(java.util.List<java.lang.String> urls, java.util.Map<java.lang.Object,java.lang.Object> macroMap) Replace the macro in the given tracker URLs and executes them in loop.
void	setDeviceInfo(POBDeviceInfo deviceInfo) Method is used to set DeviceInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

POBTrackerHandler

public POBTrackerHandler(@NonNull
                         POBNetworkHandler networkHandler)

Method Detail

sanitizeURLScheme

@NonNull
public static java.util.List<java.lang.String> sanitizeURLScheme(@Nullable
                                                                          java.util.List<java.lang.String> urls,
                                                                          boolean isSecure)

Sanitize URLs by adding scheme/protocol to urls if not exist already.

Parameters:

urls - list of urls on which sanitization is going to apply

isSecure - boolean on which sanitization applies secure/ non-secure protocol

Returns:

returns sanitezed Url list

sanitizeURLScheme

@Nullable
public static java.lang.String sanitizeURLScheme(@Nullable
                                                           java.lang.String url,
                                                           boolean isSecure)

Sanitize URL by adding scheme/protocol to url if not exist already. Note: It is temporary provision to process t.pubmatic tracker which comes as 'protocol independent' url in ad response. Network handler is not able to handle protocol independent urls. if isSecure param is true then returns url with secure protocol else returns non-secure url

Parameters:

url - url on which sanitization is going to apply

isSecure - boolean on which sanitization applies secure/ non-secure protocol

Returns:

returns sanitized Url

setDeviceInfo

public void setDeviceInfo(@Nullable
                          POBDeviceInfo deviceInfo)

Method is used to set DeviceInfo

Parameters:

deviceInfo - of type PMDeviceInfo

sendTrackers

public void sendTrackers(@Nullable
                         java.util.List<java.lang.String> urls)

Method is used to send/fire tracker multiple url

Parameters:

urls - list of url

sendTracker

public void sendTracker(@Nullable
                        java.lang.String url)

Method is used to send/fir tracker after validating success

Parameters:

url - on which tracker to be send

handleTrackersForError

public void handleTrackersForError(@Nullable
                                   java.util.List<java.lang.String> urls,
                                   @Nullable
                                   java.util.Map<java.lang.Object,java.lang.Object> macroMap,
                                   @Nullable
                                   java.util.Map<java.lang.String,java.lang.String> queryMap)

Executes tracker urls with macro map in loop and appends query params to pubmatic tracker urls

Parameters:

urls - List of tracker URLs

macroMap - Macros to be replaced in the tracker URLs

queryMap - additional data that needs to be added as query params

sendTrackers

public void sendTrackers(@Nullable
                         java.util.List<java.lang.String> urls,
                         @Nullable
                         java.util.Map<java.lang.Object,java.lang.Object> macroMap)

Replace the macro in the given tracker URLs and executes them in loop.

Parameters:

urls - List of tracker URLs

macroMap - Macros to be replaced in the tracker URLs

sendTracker

public void sendTracker(@Nullable
                        java.lang.String url,
                        @Nullable
                        java.util.Map<java.lang.Object,java.lang.Object> macroMap)

Replace the macro in the given tracker URL.

Parameters:

url - Tracker URL

macroMap - Macros to be replaced in the tracker URL

sendTracker

public void sendTracker(@Nullable
                        java.lang.String url,
                        @Nullable
                        java.lang.String regex,
                        @Nullable
                        java.lang.String replacement)

executeJsScripts

@MainThread
public void executeJsScripts(@NonNull
                                         POBWebView webView,
                                         @NonNull
                                         java.lang.String htmlContent)

Function used to execute the list of script tags or url of js files.

Parameters:

webView - WebView instance for executing js script

htmlContent - Html formatted string for execution