org.neo4j.ogm.driver.ExceptionTranslator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-ogm-api Show documentation

Neo4j-OGM's internal Api for connecting different transports.

The newest version!

/*
 * Copyright (c) 2002-2024 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed 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.neo4j.ogm.driver;

/**
 * This is a helper class modelled roughly after {@code org.springframework.dao.support.PersistenceExceptionTranslator}.
 * 

 * There are several situations where exceptions that happen inside a specific driver bubbles up into the core and cannot
 * be caught inside the driver. This is especially true for the bolt driver: The {@code org.neo4j.ogm.drivers.bolt.response.BoltResponse}
 * keeps an open result set which might throw a {@code org.neo4j.driver.exceptions.ServiceUnavailableException} at
 * a very late stage.
 * 

 * This should be handled gracefully inside the {@code org.neo4j.ogm.session.Neo4jSession}. It uses this translator to
 * translate driver specific exceptions into exception declared in the Neo4j-OGM api.
 *
 * @author Michael J. Simons
 * @soundtrack Die Toten Hosen - Crash Landing
 * @since 3.2
 */
@FunctionalInterface
public interface ExceptionTranslator {

    /**
     * Translates exceptions thrown by any of the drivers into exceptions defined in the Neo4j-OGM api.
     * It has to deal with very generic throwables due to the way Neo4jSession has been modelled.
     *
     * @param e Exception to translate
     * @return The translated exception or {@code e} itself if a translation is not possible.
     */
    RuntimeException translateExceptionIfPossible(Throwable e);
}