com.google.api.gax.grpc.GrpcApiExceptionFactory Maven / Gradle / Ivy
Show all versions of gax-grpc Show documentation
/*
* Copyright 2017 Google LLC
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.api.gax.grpc;
import com.google.api.gax.rpc.ApiException;
import com.google.api.gax.rpc.ApiExceptionFactory;
import com.google.api.gax.rpc.ErrorDetails;
import com.google.api.gax.rpc.StatusCode.Code;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableSet;
import com.google.protobuf.InvalidProtocolBufferException;
import io.grpc.Metadata;
import io.grpc.Status;
import io.grpc.StatusException;
import io.grpc.StatusRuntimeException;
import java.util.Set;
/**
* Core logic for transforming GRPC exceptions into {@link ApiException}s. This logic is shared
* amongst all the call types.
*
* Package-private for internal use.
*/
class GrpcApiExceptionFactory {
@VisibleForTesting static final String ERROR_DETAIL_KEY = "grpc-status-details-bin";
private final ImmutableSet retryableCodes;
GrpcApiExceptionFactory(Set retryCodes) {
this.retryableCodes = ImmutableSet.copyOf(retryCodes);
}
ApiException create(Throwable throwable) {
if (throwable instanceof StatusException) {
StatusException e = (StatusException) throwable;
return create(throwable, e.getStatus().getCode(), e.getTrailers());
} else if (throwable instanceof StatusRuntimeException) {
StatusRuntimeException e = (StatusRuntimeException) throwable;
return create(throwable, e.getStatus().getCode(), e.getTrailers());
} else if (throwable instanceof ApiException) {
return (ApiException) throwable;
} else {
// Do not retry on unknown throwable, even when UNKNOWN is in retryableCodes
return ApiExceptionFactory.createException(
throwable, GrpcStatusCode.of(Status.Code.UNKNOWN), false);
}
}
private ApiException create(Throwable throwable, Status.Code statusCode, Metadata metadata) {
boolean canRetry = retryableCodes.contains(GrpcStatusCode.grpcCodeToStatusCode(statusCode));
GrpcStatusCode grpcStatusCode = GrpcStatusCode.of(statusCode);
if (metadata == null) {
return ApiExceptionFactory.createException(throwable, grpcStatusCode, canRetry);
}
byte[] bytes = metadata.get(Metadata.Key.of(ERROR_DETAIL_KEY, Metadata.BINARY_BYTE_MARSHALLER));
if (bytes == null) {
return ApiExceptionFactory.createException(throwable, grpcStatusCode, canRetry);
}
com.google.rpc.Status status;
try {
status = com.google.rpc.Status.parseFrom(bytes);
} catch (InvalidProtocolBufferException e) {
return ApiExceptionFactory.createException(throwable, grpcStatusCode, canRetry);
}
ErrorDetails.Builder errorDetailsBuilder = ErrorDetails.builder();
errorDetailsBuilder.setRawErrorMessages(status.getDetailsList());
return ApiExceptionFactory.createException(
throwable, grpcStatusCode, canRetry, errorDetailsBuilder.build());
}
}