com.pubmatic.sdk.common

Class POBError

java.lang.Object

com.pubmatic.sdk.common.POBError

public class POBError
extends java.lang.Object

Maintains the OpenWrap error code along with specific error message

Field Summary

Fields

Modifier and Type	Field and Description
static int	AD_ALREADY_SHOWN Indicates the Ad is already shown
static int	AD_EXPIRED Indicates an ad is expired
static int	AD_NOT_READY Indicated the Ad is not ready to show yet.
static int	AD_REQUEST_NOT_ALLOWED Indicates an ad request is not allowed.
static int	CLIENT_SIDE_AUCTION_LOST Indicates error due to client side auction loss
static int	INTERNAL_ERROR Internal error
static int	INVALID_CONFIG Indicated the OpenWrapSDKConfig is invalid.
static int	INVALID_REQUEST You may not passing mandatory parameters like Publisher ID, Sizes, and other ad tag details.
static int	INVALID_RESPONSE Invalid ad response.
static int	INVALID_REWARD_SELECTED Indicates invalid reward selection
static int	NETWORK_ERROR There was an error while retrieving the data from the network.
static int	NO_ADS_AVAILABLE There was no ads available to deliver for ad request.
static int	OPENWRAP_SIGNALING_ERROR Ad server SDK sent unexpectd/delayed OpenWrap win response
static int	RENDER_ERROR There was some issue while rendering the creative.
static int	REQUEST_CANCELLED Ad request gets cancelled.
static int	REWARD_NOT_SELECTED Indicates Rewarded ad has encountered some configuration error
static int	SERVER_ERROR Failed to process ad request by Ad Server.
static int	TIMEOUT_ERROR Ad request was timed out

Constructor Summary

Constructors

Constructor and Description
POBError(int errorCode, java.lang.String message)

Method Summary

Modifier and Type	Method and Description
void	addExtraInfo(java.lang.String key, java.lang.Object value) Sets the key-value pair for the extra information needed for identifying the granular level of error
int	getErrorCode() Returns the integer value of the error code.
java.lang.String	getErrorMessage() Returns the descriptive message for probable fix
java.util.Map<java.lang.String,java.lang.Object>	getExtraInfo() returns the extra info needed for identifying the granular level of error identification
java.lang.Object	getExtraInfo(java.lang.String key) Returns the extra info needed for identifying the granular level of error identification based on provided key
void	setErrorCode(int errorCode) Deprecated. Use POBError(int, String) to pass the errorCode
void	setErrorMessage(java.lang.String errorMessage) Deprecated. Use POBError(int, String) to pass the errorMessage
void	setExtraInfo(java.util.Map<java.lang.String,java.lang.Object> extraInfo) Sets the map containing the extra information needed for identifying the granular level of error
java.lang.String	toString() Returns the descriptive/string format of current error object.

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_REQUEST

public static final int INVALID_REQUEST

You may not passing mandatory parameters like Publisher ID, Sizes, and other ad tag details.

See Also:

Constant Field Values

NO_ADS_AVAILABLE

public static final int NO_ADS_AVAILABLE

There was no ads available to deliver for ad request.

See Also:

Constant Field Values

NETWORK_ERROR

public static final int NETWORK_ERROR

There was an error while retrieving the data from the network.

See Also:

Constant Field Values

SERVER_ERROR

public static final int SERVER_ERROR

Failed to process ad request by Ad Server.

See Also:

Constant Field Values

TIMEOUT_ERROR

public static final int TIMEOUT_ERROR

Ad request was timed out

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Internal error

See Also:

Constant Field Values

INVALID_RESPONSE

public static final int INVALID_RESPONSE

Invalid ad response. SDK does not able to parse the response received from Server.

See Also:

Constant Field Values

REQUEST_CANCELLED

public static final int REQUEST_CANCELLED

Ad request gets cancelled.

See Also:

Constant Field Values

RENDER_ERROR

public static final int RENDER_ERROR

There was some issue while rendering the creative.

See Also:

Constant Field Values

OPENWRAP_SIGNALING_ERROR

public static final int OPENWRAP_SIGNALING_ERROR

Ad server SDK sent unexpectd/delayed OpenWrap win response

See Also:

Constant Field Values

AD_EXPIRED

public static final int AD_EXPIRED

Indicates an ad is expired

See Also:

Constant Field Values

AD_REQUEST_NOT_ALLOWED

public static final int AD_REQUEST_NOT_ALLOWED

Indicates an ad request is not allowed.

See Also:

Constant Field Values

INVALID_CONFIG

public static final int INVALID_CONFIG

Indicated the OpenWrapSDKConfig is invalid.

See Also:

Constant Field Values

AD_ALREADY_SHOWN

public static final int AD_ALREADY_SHOWN

Indicates the Ad is already shown

See Also:

Constant Field Values

AD_NOT_READY

public static final int AD_NOT_READY

Indicated the Ad is not ready to show yet.

See Also:

Constant Field Values

CLIENT_SIDE_AUCTION_LOST

public static final int CLIENT_SIDE_AUCTION_LOST

Indicates error due to client side auction loss

See Also:

Constant Field Values

INVALID_REWARD_SELECTED

public static final int INVALID_REWARD_SELECTED

Indicates invalid reward selection

See Also:

Constant Field Values

REWARD_NOT_SELECTED

public static final int REWARD_NOT_SELECTED

Indicates Rewarded ad has encountered some configuration error

See Also:

Constant Field Values

Constructor Detail

POBError

public POBError(int errorCode,
                @NonNull
                java.lang.String message)

Method Detail

getErrorCode

public int getErrorCode()

Returns the integer value of the error code.

Returns:

error code value

getErrorMessage

@NonNull
public java.lang.String getErrorMessage()

Returns the descriptive message for probable fix

Returns:

Error message

getExtraInfo

@Nullable
public java.util.Map<java.lang.String,java.lang.Object> getExtraInfo()

returns the extra info needed for identifying the granular level of error identification

Returns:

Map containing the extra info

setExtraInfo

public void setExtraInfo(@Nullable
                         java.util.Map<java.lang.String,java.lang.Object> extraInfo)

Sets the map containing the extra information needed for identifying the granular level of error

Parameters:

extraInfo - Map containing the extra information

setErrorCode

@Deprecated
public void setErrorCode(int errorCode)

Deprecated. Use POBError(int, String) to pass the errorCode

(Internal for OpenWrap SDK)

Parameters:

errorCode - error code

setErrorMessage

@Deprecated
public void setErrorMessage(@NonNull
                                        java.lang.String errorMessage)

Deprecated. Use POBError(int, String) to pass the errorMessage

(Internal for OpenWrap SDK)

Parameters:

errorMessage - error message

getExtraInfo

@Nullable
public java.lang.Object getExtraInfo(@Nullable
                                               java.lang.String key)

Returns the extra info needed for identifying the granular level of error identification based on provided key

Parameters:

key - Key for expected information

Returns:

Object for extra information

addExtraInfo

public void addExtraInfo(java.lang.String key,
                         java.lang.Object value)

Sets the key-value pair for the extra information needed for identifying the granular level of error

Parameters:

key - Key for saving the extra information

value - Value for extra info

toString

@NonNull
public java.lang.String toString()

Returns the descriptive/string format of current error object.

Overrides:

toString in class java.lang.Object

Returns:

Descriptive error message