com.datastax.astra.client.exception.DataApiException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of astra-db-java Show documentation
Implementation of a client to the Astra/Stargate Data API written in Java
There is a newer version: 1.5.3
package com.datastax.astra.client.exception;

/*-
 * #%L
 * Data API Java Client
 * --
 * Copyright (C) 2024 DataStax
 * --
 * Licensed under the Apache License, Version 2.0
 * You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import lombok.Getter;

/**
 * Represents a runtime exception that occurs within the Data API client. This exception
 * is thrown to indicate a problem encountered while performing operations such as querying,
 * updating, or deleting data through the Data API. It acts as a wrapper for lower-level exceptions
 * to provide a more general fault indication to the client code.
 * 
 * This exception should be caught and handled by the client application to gracefully
 * manage API-related errors, such as connectivity issues, data format mismatches, or unauthorized
 * access attempts. It is recommended to log the details of this exception and present a user-friendly
 * message to the end-user, if applicable.
 * 
 * Example usage:
 *  * {@code
 * try {
 *     collection.insertOne(document);
 * } catch (DataApiException e) {
 *     // Handle the exception, e.g., log it or display an error message
 *     log.error("Error performing Data API operation: " + e.getMessage(), e);
 * }
 * }
 * 
 *
 * @see RuntimeException
 */
@Getter
public class DataApiException extends RuntimeException {

    /** Serial. */
    private static final long serialVersionUID = 1L;

    /** Default error message. */
    public static final String DEFAULT_ERROR_MESSAGE = "Unexpected error occurred for Data API";

    /** Default error code. */
    public static final String DEFAULT_ERROR_CODE = "CLIENT_ERROR";

    /** Default error code. */
    public static final String ERROR_CODE_TIMEOUT = "CLIENT_TIMEOUT";

    /** Default error code. */
    public static final String ERROR_CODE_INTERRUPTED = "CLIENT_INTERRUPTED";

    /** Default error code. */
    public static final String ERROR_CODE_RANDOM = "CLIENT_RANDOM";

    /** Default error code. */
    public static final String ERROR_CODE_HTTP = "CLIENT_HTTP";

    /** Default error code. */
    public static final String ERROR_CODE_SERIALIZATION = "CLIENT_SERIALIZATION";

    /** Error. */
    private final String errorCode;

    /**
     *Constructors providing all arguments and a parent exception.
     *
     * @param errorMessage
     *      error message
     * @param errorCode
     *      error code
     */
    public DataApiException(String errorCode, String errorMessage) {
        super("[" + errorCode + "] - " + errorMessage);
        this.errorCode = errorCode;
    }

    /**
     * Constructors providing all arguments and a parent exception.
     *
     * @param errorMessage
     *      error message
     * @param errorCode
     *      error code
     * @param parent
     *      parent exception
     */
    public DataApiException(String errorMessage, String errorCode, Throwable parent) {
        super(errorMessage, parent);
        this.errorCode = errorCode;
    }

}