com.google.cloud.hadoop.util

Class ApiErrorExtractor

java.lang.Object

com.google.cloud.hadoop.util.ApiErrorExtractor

public class ApiErrorExtractor
extends java.lang.Object

Translates exceptions from API calls into higher-level meaning, while allowing injectability for testing how API errors are handled.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_NOT_CONFIGURED_REASON_CODE
static java.lang.String	ACCOUNT_DISABLED_REASON_CODE
static java.lang.String	FIELD_SIZE_TOO_LARGE
static java.lang.String	GLOBAL_DOMAIN
static ApiErrorExtractor	INSTANCE Singleton instance of the ApiErrorExtractor.
static java.lang.String	RATE_LIMITED_REASON_CODE
static java.lang.String	RESOURCE_NOT_READY_REASON_CODE
static int	STATUS_CODE_CONFLICT
static int	STATUS_CODE_PRECONDITION_FAILED
static int	STATUS_CODE_RANGE_NOT_SATISFIABLE
static java.lang.String	USAGE_LIMITS_DOMAIN
static java.lang.String	USER_PROJECT_MISSING
static java.lang.String	USER_RATE_LIMITED_REASON_CODE

Constructor Summary

Constructors

Constructor and Description
ApiErrorExtractor() Deprecated. use INSTANCE instead

Method Summary

Modifier and Type	Method and Description
boolean	accessDenied(java.io.IOException e) Determines if the given exception indicates 'access denied'.
boolean	accessDeniedNonRecoverable(com.google.api.client.googleapis.json.GoogleJsonError e) Determine if a given GoogleJsonError is caused by, and only by, account disabled error.
boolean	accessDeniedNonRecoverable(java.io.IOException e) Determine if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).
boolean	fieldSizeTooLarge(com.google.api.client.googleapis.json.GoogleJsonError e) Determines if the given GoogleJsonError indicates 'field size too large'.
boolean	fieldSizeTooLarge(java.io.IOException e) Determines if the given exception indicates 'field size too large'.
java.lang.String	getDebugInfo(java.io.IOException ioe)
protected com.google.api.client.googleapis.json.GoogleJsonError	getDetails(java.io.IOException e) If the exception is a GoogleJsonResponseException, get the error details, else return null.
protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo	getErrorInfo(com.google.api.client.googleapis.json.GoogleJsonError details) Get the first ErrorInfo from a GoogleJsonError, or null if there is not one.
protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo	getErrorInfo(java.io.IOException e) Get the first ErrorInfo from an IOException if it is an instance of GoogleJsonResponseException, otherwise return null.
java.lang.String	getErrorMessage(java.io.IOException e) Extracts the error message.
protected int	getHttpStatusCode(com.google.api.client.googleapis.json.GoogleJsonResponseException e) Returns HTTP status code from the given exception.
static com.google.api.client.googleapis.json.GoogleJsonResponseException	getJsonResponseExceptionOrNull(java.lang.Throwable t)
boolean	ioError(java.lang.Throwable throwable) Determine if a given Throwable is caused by an IO error.
boolean	isClientError(java.io.IOException e) Determines if the exception is a client error.
boolean	isInternalServerError(java.io.IOException e) Determines if the exception is an internal server error.
boolean	itemAlreadyExists(java.io.IOException e) Determines if the given exception indicates 'item already exists'.
boolean	itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e) Determines if the given GoogleJsonError indicates 'item not found'.
boolean	itemNotFound(java.io.IOException e) Determines if the given exception indicates 'item not found'.
boolean	preconditionNotMet(com.google.api.client.googleapis.json.GoogleJsonError e) Determines if the given GoogleJsonError indicates 'precondition not met'
boolean	preconditionNotMet(java.io.IOException e) Determine if the given IOException indicates 'precondition not met' Recursively checks getCause() if outer exception isn't an instance of the correct class.
boolean	rangeNotSatisfiable(java.io.IOException e) Determines if the given exception indicates 'range not satisfiable'.
boolean	rateLimited(com.google.api.client.googleapis.json.GoogleJsonError e) Determine if a given GoogleJsonError is caused by, and only by, a rate limit being applied.
boolean	rateLimited(java.lang.Throwable throwable) Determine if a given Throwable is caused by a rate limit being applied.
boolean	readTimedOut(java.io.IOException ex) True if the exception is a "read timed out".
protected boolean	recursiveCheckForCode(java.lang.Throwable e, int code) Recursively checks getCause() if outer exception isn't an instance of the correct class.
boolean	resourceNotReady(com.google.api.client.googleapis.json.GoogleJsonError e) Determines if the given GoogleJsonError indicates 'resource not ready'.
boolean	resourceNotReady(java.io.IOException e) Determines if the given exception indicates 'resource not ready'.
boolean	socketError(java.lang.Throwable throwable) Determine if a given Throwable is caused by a socket error.
java.io.IOException	toUserPresentableException(java.io.IOException ioe, java.lang.String action) Converts the exception to a user-presentable error message.
java.lang.String	toUserPresentableMessage(java.io.IOException ioe)
java.lang.String	toUserPresentableMessage(java.io.IOException ioe, java.lang.String action) Converts the exception to a user-presentable error message.
boolean	unauthorized(java.io.IOException e) Determine if the given exception indicates the request was unauthenticated.
boolean	userProjectMissing(com.google.api.client.googleapis.json.GoogleJsonError e) Determines if the given GoogleJsonError indicates that 'userProject' is missing in request
boolean	userProjectMissing(java.io.IOException e) Determines if the given exception indicates that 'userProject' is missing in request.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ApiErrorExtractor INSTANCE

Singleton instance of the ApiErrorExtractor.

STATUS_CODE_CONFLICT

public static final int STATUS_CODE_CONFLICT

See Also:

Constant Field Values

STATUS_CODE_PRECONDITION_FAILED

public static final int STATUS_CODE_PRECONDITION_FAILED

See Also:

Constant Field Values

STATUS_CODE_RANGE_NOT_SATISFIABLE

public static final int STATUS_CODE_RANGE_NOT_SATISFIABLE

See Also:

Constant Field Values

GLOBAL_DOMAIN

public static final java.lang.String GLOBAL_DOMAIN

See Also:

Constant Field Values

USAGE_LIMITS_DOMAIN

public static final java.lang.String USAGE_LIMITS_DOMAIN

See Also:

Constant Field Values

RATE_LIMITED_REASON_CODE

public static final java.lang.String RATE_LIMITED_REASON_CODE

See Also:

Constant Field Values

USER_RATE_LIMITED_REASON_CODE

public static final java.lang.String USER_RATE_LIMITED_REASON_CODE

See Also:

Constant Field Values

ACCOUNT_DISABLED_REASON_CODE

public static final java.lang.String ACCOUNT_DISABLED_REASON_CODE

See Also:

Constant Field Values

ACCESS_NOT_CONFIGURED_REASON_CODE

public static final java.lang.String ACCESS_NOT_CONFIGURED_REASON_CODE

See Also:

Constant Field Values

RESOURCE_NOT_READY_REASON_CODE

public static final java.lang.String RESOURCE_NOT_READY_REASON_CODE

See Also:

Constant Field Values

FIELD_SIZE_TOO_LARGE

public static final java.lang.String FIELD_SIZE_TOO_LARGE

See Also:

Constant Field Values

USER_PROJECT_MISSING

public static final java.lang.String USER_PROJECT_MISSING

See Also:

Constant Field Values

Constructor Detail

ApiErrorExtractor

@Deprecated
public ApiErrorExtractor()

Deprecated. use INSTANCE instead

Method Detail

accessDenied

public boolean accessDenied(java.io.IOException e)

Determines if the given exception indicates 'access denied'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

Warning: this method only checks for access denied status code, however this may include potentially recoverable reason codes such as rate limiting. For alternative, see accessDeniedNonRecoverable(IOException).

unauthorized

public boolean unauthorized(java.io.IOException e)

Determine if the given exception indicates the request was unauthenticated. This can be caused by attaching invalid credentials to a request.

accessDeniedNonRecoverable

public boolean accessDeniedNonRecoverable(java.io.IOException e)

Determine if the exception is a non-recoverable access denied code (such as account closed or marked for deletion).

accessDeniedNonRecoverable

public boolean accessDeniedNonRecoverable(com.google.api.client.googleapis.json.GoogleJsonError e)

Determine if a given GoogleJsonError is caused by, and only by, account disabled error.

isClientError

public boolean isClientError(java.io.IOException e)

Determines if the exception is a client error.

isInternalServerError

public boolean isInternalServerError(java.io.IOException e)

Determines if the exception is an internal server error.

itemAlreadyExists

public boolean itemAlreadyExists(java.io.IOException e)

Determines if the given exception indicates 'item already exists'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

itemNotFound

public boolean itemNotFound(com.google.api.client.googleapis.json.GoogleJsonError e)

Determines if the given GoogleJsonError indicates 'item not found'.

itemNotFound

public boolean itemNotFound(java.io.IOException e)

Determines if the given exception indicates 'item not found'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

fieldSizeTooLarge

public boolean fieldSizeTooLarge(com.google.api.client.googleapis.json.GoogleJsonError e)

Determines if the given GoogleJsonError indicates 'field size too large'.

fieldSizeTooLarge

public boolean fieldSizeTooLarge(java.io.IOException e)

Determines if the given exception indicates 'field size too large'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

resourceNotReady

public boolean resourceNotReady(com.google.api.client.googleapis.json.GoogleJsonError e)

Determines if the given GoogleJsonError indicates 'resource not ready'.

resourceNotReady

public boolean resourceNotReady(java.io.IOException e)

Determines if the given exception indicates 'resource not ready'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

preconditionNotMet

public boolean preconditionNotMet(com.google.api.client.googleapis.json.GoogleJsonError e)

Determines if the given GoogleJsonError indicates 'precondition not met'

preconditionNotMet

public boolean preconditionNotMet(java.io.IOException e)

Determine if the given IOException indicates 'precondition not met' Recursively checks getCause() if outer exception isn't an instance of the correct class.

rangeNotSatisfiable

public boolean rangeNotSatisfiable(java.io.IOException e)

Determines if the given exception indicates 'range not satisfiable'. Recursively checks getCause() if outer exception isn't an instance of the correct class.

rateLimited

public boolean rateLimited(com.google.api.client.googleapis.json.GoogleJsonError e)

Determine if a given GoogleJsonError is caused by, and only by, a rate limit being applied.

Parameters:

e - The GoogleJsonError returned by the request

Returns:

True if the error is caused by a rate limit being applied.

rateLimited

public boolean rateLimited(java.lang.Throwable throwable)

Determine if a given Throwable is caused by a rate limit being applied. Recursively checks getCause() if outer exception isn't an instance of the correct class.

Parameters:

throwable - The Throwable to check.

Returns:

True if the Throwable is a result of rate limiting being applied.

userProjectMissing

public boolean userProjectMissing(com.google.api.client.googleapis.json.GoogleJsonError e)

Determines if the given GoogleJsonError indicates that 'userProject' is missing in request

userProjectMissing

public boolean userProjectMissing(java.io.IOException e)

Determines if the given exception indicates that 'userProject' is missing in request. Recursively checks getCause() if outer exception isn't an instance of the correct class.

ioError

public boolean ioError(java.lang.Throwable throwable)

Determine if a given Throwable is caused by an IO error. Recursively checks getCause() if outer exception isn't an instance of the correct class.

Parameters:

throwable - The Throwable to check.

Returns:

True if the Throwable is a result of an IO error.

socketError

public boolean socketError(java.lang.Throwable throwable)

Determine if a given Throwable is caused by a socket error. Recursively checks getCause() if outer exception isn't an instance of the correct class.

Parameters:

throwable - The Throwable to check.

Returns:

True if the Throwable is a result of a socket error.

readTimedOut

public boolean readTimedOut(java.io.IOException ex)

True if the exception is a "read timed out".

getErrorMessage

public java.lang.String getErrorMessage(java.io.IOException e)

Extracts the error message.

toUserPresentableException

public java.io.IOException toUserPresentableException(java.io.IOException ioe,
                                                      java.lang.String action)
                                               throws java.io.IOException

Converts the exception to a user-presentable error message. Specifically, extracts message field for HTTP 4xx codes, and creates a generic "Internal Server Error" for HTTP 5xx codes.

Parameters:

ioe - the exception

action - the description of the action being performed at the time of error.

Throws:

java.io.IOException

See Also:

toUserPresentableMessage(IOException, String)

toUserPresentableMessage

public java.lang.String toUserPresentableMessage(java.io.IOException ioe,
                                                 @Nullable
                                                 java.lang.String action)

Converts the exception to a user-presentable error message. Specifically, extracts message field for HTTP 4xx codes, and creates a generic "Internal Server Error" for HTTP 5xx codes.

toUserPresentableMessage

public java.lang.String toUserPresentableMessage(java.io.IOException ioe)

See Also:

toUserPresentableMessage(IOException, String)

getDebugInfo

@Nullable
public java.lang.String getDebugInfo(java.io.IOException ioe)

getHttpStatusCode

protected int getHttpStatusCode(com.google.api.client.googleapis.json.GoogleJsonResponseException e)

Returns HTTP status code from the given exception.

Note: GoogleJsonResponseException.getStatusCode() method is marked final therefore it cannot be mocked using Mockito. We use this helper so that we can override it in tests.

getErrorInfo

protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo getErrorInfo(java.io.IOException e)

Get the first ErrorInfo from an IOException if it is an instance of GoogleJsonResponseException, otherwise return null.

getDetails

protected com.google.api.client.googleapis.json.GoogleJsonError getDetails(java.io.IOException e)

If the exception is a GoogleJsonResponseException, get the error details, else return null.

getErrorInfo

protected com.google.api.client.googleapis.json.GoogleJsonError.ErrorInfo getErrorInfo(com.google.api.client.googleapis.json.GoogleJsonError details)

Get the first ErrorInfo from a GoogleJsonError, or null if there is not one.

recursiveCheckForCode

protected boolean recursiveCheckForCode(java.lang.Throwable e,
                                        int code)

Recursively checks getCause() if outer exception isn't an instance of the correct class.

getJsonResponseExceptionOrNull

@Nullable
public static com.google.api.client.googleapis.json.GoogleJsonResponseException getJsonResponseExceptionOrNull(java.lang.Throwable t)