Class ApiError

fluss-rpc/src/main/java/org/apache/fluss/rpc/protocol/ApiError.java:34–154

Encapsulates an error code (via the Errors enum) and an optional message. Generally, the optional message is only defined if it adds information over the default message associated with the error code.

 * code.
 */
public class ApiError {

    private static final int MAX_ERROR_MESSAGE_LENGTH = 2048;
    public static final ApiError NONE = Errors.NONE.toApiError();

    private final Errors error;
    private final @Nullable String message;

    public static ApiError fromThrowable(Throwable t) {
        Throwable throwableToBeEncoded = Errors.maybeUnwrapException(t);
        Errors error = Errors.forException(throwableToBeEncoded);
        final String message;
        if (Objects.equals(error.message(), throwableToBeEncoded.getMessage())) {
            message = null;
        } else if (error.code() == Errors.UNKNOWN_SERVER_ERROR.code()) {
            // we populate error stack message for UNKNOWN_SERVER_ERROR for easy debugging,
            // but we may need to avoid this to not leak sensitive information in the future.
            String errorStack = ExceptionUtils.stringifyException(throwableToBeEncoded);
            // tailor the error stack to reduce the network cost.
            message =
                    errorStack.length() > MAX_ERROR_MESSAGE_LENGTH
                            ? errorStack.substring(0, MAX_ERROR_MESSAGE_LENGTH)
                            : errorStack;
        } else {
            message = throwableToBeEncoded.getMessage();
        }
        return new ApiError(error, message);
    }

    public static ApiError fromErrorMessage(ErrorMessage msg) {
        Errors code = msg.hasErrorCode() ? Errors.forCode(msg.getErrorCode()) : Errors.NONE;
        String message = msg.hasErrorMessage() ? msg.getErrorMessage() : null;
        return new ApiError(code, message);
    }

    public ApiError(Errors error, @Nullable String message) {
        this.error = error;
        this.message = message;
    }

    public boolean isFailure() {
        return !isSuccess();
    }

    public boolean isSuccess() {
        return this.error == Errors.NONE;
    }

    public Errors error() {
        return error;
    }

    /**
     * Return the associated optional error message or null.
     *
     * <p>Note: the returned message can be null and is useful for transport to reduce unnecessary
     * network cost.
     */