ai.grakn.exception.GraknServerException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grakn-core Show documentation
There is a newer version: 1.4.3
/*
 * GRAKN.AI - THE KNOWLEDGE GRAPH
 * Copyright (C) 2018 Grakn Labs Ltd
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */

package ai.grakn.exception;

import ai.grakn.Keyspace;

import static ai.grakn.util.ErrorMessage.CANNOT_DELETE_KEYSPACE;
import static ai.grakn.util.ErrorMessage.MISSING_MANDATORY_BODY_REQUEST_PARAMETERS;
import static ai.grakn.util.ErrorMessage.MISSING_MANDATORY_REQUEST_PARAMETERS;
import static ai.grakn.util.ErrorMessage.MISSING_REQUEST_BODY;
import static ai.grakn.util.ErrorMessage.UNSUPPORTED_CONTENT_TYPE;
import static org.apache.http.HttpStatus.SC_BAD_REQUEST;
import static org.apache.http.HttpStatus.SC_INTERNAL_SERVER_ERROR;
import static org.apache.http.HttpStatus.SC_NOT_ACCEPTABLE;

/**
 * 
 *     Grakn Server Exception
 * 
 *
 * 
 *     Wraps backend exception which require a status code which needs to be returned to the client.
 * 
 *
 * @author fppt
 */
public class GraknServerException extends GraknBackendException {
    private final int status;

    private GraknServerException(String error, Exception e, int status) {
        super(error, e);
        this.status = status;
    }

    private GraknServerException(String error, int status){
        super(error);
        this.status = status;
    }

    /**
     * Gets the error status code if one is available
     */
    public int getStatus(){
        return status;
    }

    /**
     * Thrown when a request has an invalid parameter
     */
    public static GraknServerException requestInvalidParameter(String parameter, String value){
        String message = String.format("Invalid value %s for parameter %s", value, parameter);
        return new GraknServerException(message, SC_BAD_REQUEST);
    }

    /**
     * Thrown when a request is missing mandatory parameters
     */
    public static GraknServerException requestMissingParameters(String parameter){
        return new GraknServerException(MISSING_MANDATORY_REQUEST_PARAMETERS.getMessage(parameter), SC_BAD_REQUEST);
    }

    /**
     * Thrown when a request is missing mandatory parameters in the body
     */
    public static GraknServerException requestMissingBodyParameters(String parameter){
        return new GraknServerException(
                MISSING_MANDATORY_BODY_REQUEST_PARAMETERS.getMessage(parameter), SC_BAD_REQUEST);
    }

    /**
     * Thrown when a request is missing the body
     */
    public static GraknServerException requestMissingBody(){
        return new GraknServerException(MISSING_REQUEST_BODY.getMessage(), SC_BAD_REQUEST);
    }

    /**
     * Thrown the content type specified in a request is invalid
     */
    public static GraknServerException unsupportedContentType(String contentType){
        return new GraknServerException(UNSUPPORTED_CONTENT_TYPE.getMessage(contentType), SC_NOT_ACCEPTABLE);
    }

    /**
     * Thrown when engine cannot delete a keyspace as expected
     */
    public static GraknServerException couldNotDelete(Keyspace keyspace){
        return new GraknServerException(CANNOT_DELETE_KEYSPACE.getMessage(keyspace), SC_INTERNAL_SERVER_ERROR);
    }

    /**
     * Thrown when an internal server error occurs. This is likely due to incorrect configs
     */
    public static GraknServerException internalError(String errorMessage){
        return new GraknServerException(errorMessage, SC_INTERNAL_SERVER_ERROR);
    }
}