org.neo4j.server.rest.Neo4jError Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-server Show documentation
Neo4j web server.
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://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.server.rest;

import java.io.PrintWriter;
import java.io.StringWriter;

import org.neo4j.kernel.api.exceptions.Status;

/**
 * This is an initial move towards unified errors - it should not live here in the server, but should probably
 * exist in the kernel or similar, where it can be shared across surfaces other than the server.
 * 
 * It's put in place here in order to enforce that the {@link org.neo4j.server.http.cypher.CypherResource}
 * is strictly tied down towards what errors it handles and returns to the client, to create a waterproof abstraction
 * between the runtime-exception landscape that lives below, and the errors we send to the user.
 * 
 * This way, we make it easy to transition this service over to a unified error code based error scheme.
 */
public class Neo4jError
{
    private final Status status;
    private final Throwable cause;

    public Neo4jError( Status status, String message )
    {
        this( status, new RuntimeException( message ) );
    }

    public Neo4jError( Status status, Throwable cause )
    {
        if ( status == null )
        {
            throw new IllegalArgumentException( "statusCode must not be null" );
        }
        if ( cause == null )
        {
            throw new IllegalArgumentException( "cause must not be null" );
        }

        this.status = status;
        this.cause = cause;
    }

    @Override
    public String toString()
    {
        cause.printStackTrace();
        return String.format( "%s[%s, cause=\"%s\"]",
                              getClass().getSimpleName(), status.code(), cause );
    }

    public Throwable cause()
    {
        return cause;
    }

    public Status status()
    {
        return status;
    }

    public String getMessage()
    {
        return cause.getMessage();
    }

    public boolean shouldSerializeStackTrace()
    {
        return status.code().classification() != Status.Classification.ClientError;
    }

    public String getStackTraceAsString()
    {
        StringWriter stringWriter = new StringWriter();
        PrintWriter printWriter = new PrintWriter( stringWriter );
        cause.printStackTrace( printWriter );
        return stringWriter.toString();
    }
}