/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); 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.
 */
package org.apache.tinkerpop.gremlin.driver.exception;

import io.netty.handler.codec.http.HttpResponseStatus;

/**
 * @author Stephen Mallette (http://stephen.genoprime.com)
 */
public class ResponseException extends Exception {
    private final HttpResponseStatus responseStatusCode;
    private final String remoteException;

    public ResponseException(final HttpResponseStatus responseStatusCode, final String serverMessage) {
        this(responseStatusCode, serverMessage, null);
    }

    public ResponseException(final HttpResponseStatus responseStatusCode, final String serverMessage,
                             final String remoteException) {
        super(serverMessage);
        this.responseStatusCode = responseStatusCode;
        this.remoteException = remoteException;
    }

    /**
     * Creates a {@code ResponseException} from a server response, returning the more specific
     * {@link FailResponseException} when the {@code remoteException} indicates that a {@link
     * org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal#fail()} step was triggered on the
     * server. This allows remote {@code fail()} handling to be made consistent with the local behavior.
     */
    public static ResponseException create(final HttpResponseStatus responseStatusCode, final String serverMessage,
                                           final String remoteException) {
        return FailResponseException.EXCEPTION_NAME.equals(remoteException)
                ? new FailResponseException(responseStatusCode, serverMessage)
                : new ResponseException(responseStatusCode, serverMessage, remoteException);
    }

    public HttpResponseStatus getResponseStatusCode() {
        return responseStatusCode;
    }

    /**
     * The exception generated by the server.
     */
    public String getRemoteException() {
        return remoteException;
    }
}