org.neo4j.kernel.impl.newapi.DefaultCursors Maven / Gradle / Ivy

Go to download

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

Neo4j kernel is a lightweight, embedded Java database designed to store data structured as graphs rather than tables. For more information, see http://neo4j.org.

There is a newer version: 5.25.1

Show newest version

/*
 * 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.kernel.impl.newapi;

import static java.lang.String.format;

import java.io.ByteArrayOutputStream;
import java.io.PrintStream;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection;
import org.neo4j.configuration.Config;
import org.neo4j.configuration.GraphDatabaseInternalSettings;
import org.neo4j.internal.kernel.api.AutoCloseablePlus;

abstract class DefaultCursors {
    private final Collection closeables;
    private final boolean trackCursorClose;
    private final boolean traceCursorClose;

    DefaultCursors(Collection closeables, Config config) {
        this.closeables = closeables;
        this.trackCursorClose = config.get(GraphDatabaseInternalSettings.track_cursor_close);
        this.traceCursorClose = config.get(GraphDatabaseInternalSettings.trace_cursors);
    }

    protected  T trace(T closeable) {
        if (trackCursorClose) {
            StackTraceElement[] stackTrace = null;
            if (traceCursorClose) {
                stackTrace = Thread.currentThread().getStackTrace();
                stackTrace = Arrays.copyOfRange(stackTrace, 2, stackTrace.length);
            }

            closeables.add(new CloseableStacktrace(closeable, stackTrace));
        }
        return closeable;
    }

    public void assertClosed() {
        if (trackCursorClose) {
            for (CloseableStacktrace c : closeables) {
                c.assertClosed();
            }
            closeables.clear();
        }
    }

    static class CloseableStacktrace {
        private final AutoCloseablePlus c;
        private final StackTraceElement[] stackTrace;

        CloseableStacktrace(AutoCloseablePlus c, StackTraceElement[] stackTrace) {
            this.c = c;
            this.stackTrace = stackTrace;
        }

        void assertClosed() {
            if (!c.isClosed()) {
                ByteArrayOutputStream out = new ByteArrayOutputStream();
                PrintStream printStream = new PrintStream(out, false, StandardCharsets.UTF_8);

                if (stackTrace != null) {
                    printStream.println();
                    for (StackTraceElement traceElement : stackTrace) {
                        printStream.println("\tat " + traceElement);
                    }
                } else {
                    String msg = format(
                            " To see stack traces please set '%s' setting to true",
                            GraphDatabaseInternalSettings.trace_cursors.name());
                    printStream.print(msg);
                }
                printStream.println();
                throw new IllegalStateException(
                        format("Closeable %s was not closed!%s", c, out.toString(StandardCharsets.UTF_8)));
            }
        }
    }
}