org.neo4j.exceptions.KernelException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-common Show documentation
Non-domain infrastructure code that is common to many Neo4j components.
There is a newer version: 2025.03.0
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.exceptions;

import org.neo4j.common.TokenNameLookup;
import org.neo4j.gqlstatus.ErrorGqlStatusObject;
import org.neo4j.gqlstatus.ErrorMessageHolder;
import org.neo4j.gqlstatus.GqlException;
import org.neo4j.kernel.api.exceptions.Status;

public abstract class KernelException extends GqlException implements Status.HasStatus {
    private final Status statusCode;

    protected KernelException(Status statusCode, Throwable cause, String message, Object... parameters) {
        super(toMessage(message, parameters), cause);
        this.statusCode = statusCode;
    }

    protected KernelException(
            ErrorGqlStatusObject gqlStatusObject,
            Status statusCode,
            Throwable cause,
            String message,
            Object... parameters) {
        super(gqlStatusObject, toMessage(message, parameters), cause);
        this.statusCode = statusCode;
    }

    protected KernelException(Status statusCode, Throwable cause) {
        super(ErrorMessageHolder.getOldCauseMessage(cause), cause);
        this.statusCode = statusCode;
    }

    protected KernelException(ErrorGqlStatusObject gqlStatusObject, Status statusCode, Throwable cause) {
        super(gqlStatusObject, ErrorMessageHolder.getOldCauseMessage(cause), cause);
        this.statusCode = statusCode;
    }

    protected KernelException(Status statusCode, String message, Object... parameters) {
        super(toMessage(message, parameters));
        this.statusCode = statusCode;
    }

    protected KernelException(
            ErrorGqlStatusObject gqlStatusObject, Status statusCode, String message, Object... parameters) {
        super(gqlStatusObject, toMessage(message, parameters));
        this.statusCode = statusCode;
    }

    /** The Neo4j status code associated with this exception type. */
    @Override
    public Status status() {
        return statusCode;
    }

    public String getUserMessage(TokenNameLookup tokenNameLookup) {
        return getMessage();
    }

    private static String toMessage(String message, Object... parameters) {
        // need to check for params as some messages (when no params are provided) could have a '%' within
        // and that makes String.format most unhappy and we get exceptions thrown in exception code
        return (parameters.length > 0) ? String.format(message, parameters) : message;
    }
}