com.pubmatic.sdk.video

Class POBVastError

java.lang.Object

com.pubmatic.sdk.video.POBVastError

public class POBVastError
extends java.lang.Object

Maintains the VAST error code along with specific error message

Field Summary

Fields

Modifier and Type	Field and Description
static int	AD_DISPLAY_TIMEOUT InLine response returned ad unit that failed to result in ad display within defined time limit.
static int	COMPANION_AD_DISPLAY_ERROR Unable to display required Companion.
static int	GENERAL_COMPANION_AD_ERROR General CompanionAds error.
static int	GENERAL_LINEAR_ERROR General Linear error.
static int	GENERAL_NONLINEAR_AD_ERROR General NonLinearAds error.
static int	GENERAL_WRAPPER_ERROR General Wrapper error.
static int	INCORRECT_DURATION Media player expecting different duration.
static int	INCORRECT_LINEARITY Media player expecting different linearity.
static int	INCORRECT_SIZE Media player expecting different size.
static int	MEDIA_FILE_DISPLAY_ERROR Problem displaying MediaFile.
static int	MEDIA_FILE_NOT_FOUND File not found.
static int	MEDIA_FILE_TIMEOUT Timeout of MediaFile URI.
static int	MISSING_AD_CATEGORY Ad category was required but not provided.
static int	NO_COMPANION_AD_ERROR Unable to fetch CompanionAds/Companion resource.
static int	NO_NONLINEAR_AD Unable to fetch NonLinearAds/NonLinear resource.
static int	NO_SUPPORTED_COMPANION_AD_RESOURCE Couldn't find Companion resource with supported type.
static int	NO_SUPPORTED_MEDIA_FILE Couldn't find MediaFile that is supported by this media player, based on the attributes of the MediaFile element.
static int	NO_SUPPORTED_NONLINEAR_RESOURCE Couldn't find NonLinear resource with supported type.
static int	NO_VAST_RESPONSE No VAST response after one or more Wrappers.
static int	RECEIVED_BLOCKED_AD_CATEGORIES Inline Category violates Wrapper BlockedAdCategories
static int	SCHEMA_VALIDATION_ERROR VAST schema validation error.
static int	TRAFFICKING_ERROR Trafficking error.
static int	UNDEFINED_ERROR Undefined Error.
static int	UNSUPPORTED_COMPANION_AD Unable to display Companion because creative dimensions do not fit within Companion display area (i.e., no available space).
static int	UNSUPPORTED_NONLINEAR_AD Unable to display NonLinearAd because creative dimensions do not align with creative display area (i.e.
static int	UNSUPPORTED_VAST_VERSION Indicated vast parsing attempts has exceeded its upper limit
static int	VERIFICATION_EXECUTION_ERROR Verification unit in the Verification node was not executed.
static int	WRAPPER_THRESHOLD Wrapper limit reached, as defined by the media player.
static int	WRAPPER_TIMEOUT Timeout of VAST URI provided in Wrapper element, or of VAST URI provided in a subsequent Wrapper element.
static int	XML_PARSING_ERROR XML parsing error.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getErrorCode() Returns the integer value of the error code.
java.lang.String	getErrorMessage() Returns the descriptive message for probable fix
void	setErrorCode(int errorCode) (Internal for OpenWrap SDK)
void	setErrorMessage(java.lang.String errorMessage) (Internal for OpenWrap SDK)
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

XML_PARSING_ERROR

public static final int XML_PARSING_ERROR

XML parsing error.

See Also:

Constant Field Values

SCHEMA_VALIDATION_ERROR

public static final int SCHEMA_VALIDATION_ERROR

VAST schema validation error.

See Also:

Constant Field Values

UNSUPPORTED_VAST_VERSION

public static final int UNSUPPORTED_VAST_VERSION

Indicated vast parsing attempts has exceeded its upper limit

See Also:

Constant Field Values

TRAFFICKING_ERROR

public static final int TRAFFICKING_ERROR

Trafficking error. VAST player received an Ad type that it was not expecting and/or can't play. For example Skippable is expected but received Non-Skippable. Its a Non-fatal error.

See Also:

Constant Field Values

INCORRECT_LINEARITY

public static final int INCORRECT_LINEARITY

Media player expecting different linearity.

See Also:

Constant Field Values

INCORRECT_DURATION

public static final int INCORRECT_DURATION

Media player expecting different duration.

See Also:

Constant Field Values

INCORRECT_SIZE

public static final int INCORRECT_SIZE

Media player expecting different size.

See Also:

Constant Field Values

MISSING_AD_CATEGORY

public static final int MISSING_AD_CATEGORY

Ad category was required but not provided.

See Also:

Constant Field Values

RECEIVED_BLOCKED_AD_CATEGORIES

public static final int RECEIVED_BLOCKED_AD_CATEGORIES

Inline Category violates Wrapper BlockedAdCategories

See Also:

Constant Field Values

GENERAL_WRAPPER_ERROR

public static final int GENERAL_WRAPPER_ERROR

General Wrapper error.

See Also:

Constant Field Values

WRAPPER_TIMEOUT

public static final int WRAPPER_TIMEOUT

Timeout of VAST URI provided in Wrapper element, or of VAST URI provided in a subsequent Wrapper element. (URI was either unavailable or reached a timeout as defined by the media player.)

See Also:

Constant Field Values

WRAPPER_THRESHOLD

public static final int WRAPPER_THRESHOLD

Wrapper limit reached, as defined by the media player. Too many Wrapper responses have been received with no InLine response.

See Also:

Constant Field Values

NO_VAST_RESPONSE

public static final int NO_VAST_RESPONSE

No VAST response after one or more Wrappers.

See Also:

Constant Field Values

AD_DISPLAY_TIMEOUT

public static final int AD_DISPLAY_TIMEOUT

InLine response returned ad unit that failed to result in ad display within defined time limit.

See Also:

Constant Field Values

GENERAL_LINEAR_ERROR

public static final int GENERAL_LINEAR_ERROR

General Linear error. Media player is unable to display the Linear Ad.

See Also:

Constant Field Values

MEDIA_FILE_NOT_FOUND

public static final int MEDIA_FILE_NOT_FOUND

File not found. Unable to find Linear/MediaFile from URI.

See Also:

Constant Field Values

MEDIA_FILE_TIMEOUT

public static final int MEDIA_FILE_TIMEOUT

Timeout of MediaFile URI.

See Also:

Constant Field Values

NO_SUPPORTED_MEDIA_FILE

public static final int NO_SUPPORTED_MEDIA_FILE

Couldn't find MediaFile that is supported by this media player, based on the attributes of the MediaFile element.

See Also:

Constant Field Values

MEDIA_FILE_DISPLAY_ERROR

public static final int MEDIA_FILE_DISPLAY_ERROR

Problem displaying MediaFile. Media player found a MediaFile with supported type but couldn't display it. MediaFile may include: unsupported codecs, different MIME type than MediaFile@type, unsupported delivery method, etc.

See Also:

Constant Field Values

VERIFICATION_EXECUTION_ERROR

public static final int VERIFICATION_EXECUTION_ERROR

Verification unit in the Verification node was not executed.

See Also:

Constant Field Values

GENERAL_NONLINEAR_AD_ERROR

public static final int GENERAL_NONLINEAR_AD_ERROR

General NonLinearAds error.

See Also:

Constant Field Values

UNSUPPORTED_NONLINEAR_AD

public static final int UNSUPPORTED_NONLINEAR_AD

Unable to display NonLinearAd because creative dimensions do not align with creative display area (i.e. creative dimension too large).

See Also:

Constant Field Values

NO_NONLINEAR_AD

public static final int NO_NONLINEAR_AD

Unable to fetch NonLinearAds/NonLinear resource.

See Also:

Constant Field Values

NO_SUPPORTED_NONLINEAR_RESOURCE

public static final int NO_SUPPORTED_NONLINEAR_RESOURCE

Couldn't find NonLinear resource with supported type.

See Also:

Constant Field Values

GENERAL_COMPANION_AD_ERROR

public static final int GENERAL_COMPANION_AD_ERROR

General CompanionAds error.

See Also:

Constant Field Values

UNSUPPORTED_COMPANION_AD

public static final int UNSUPPORTED_COMPANION_AD

Unable to display Companion because creative dimensions do not fit within Companion display area (i.e., no available space).

See Also:

Constant Field Values

COMPANION_AD_DISPLAY_ERROR

public static final int COMPANION_AD_DISPLAY_ERROR

Unable to display required Companion.

See Also:

Constant Field Values

NO_COMPANION_AD_ERROR

public static final int NO_COMPANION_AD_ERROR

Unable to fetch CompanionAds/Companion resource.

See Also:

Constant Field Values

NO_SUPPORTED_COMPANION_AD_RESOURCE

public static final int NO_SUPPORTED_COMPANION_AD_RESOURCE

Couldn't find Companion resource with supported type.

See Also:

Constant Field Values

UNDEFINED_ERROR

public static final int UNDEFINED_ERROR

Undefined Error.

See Also:

Constant Field Values

Constructor Detail

POBVastError

public POBVastError(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

setErrorCode

public void setErrorCode(int errorCode)

(Internal for OpenWrap SDK)

Parameters:

errorCode - error code

getErrorMessage

public java.lang.String getErrorMessage()

Returns the descriptive message for probable fix

Returns:

Error message

setErrorMessage

public void setErrorMessage(java.lang.String errorMessage)

(Internal for OpenWrap SDK)

Parameters:

errorMessage - error message

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