org.neo4j.kernel.impl.api.LeaseClient 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 [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.kernel.impl.api;

public interface LeaseClient
{
    /**
     * The ID of an acquired lease.
     *
     * Will be {@link LeaseService#NO_LEASE} before ensureValid() has been called and keeps
     * its value even if the lease becomes invalid.
     */
    int leaseId();

    /**
     * Ensures that a valid lease is held or throws an exception.
     *
     * If no lease is held, then an attempt it made to acquire the lease.
     * If a previously valid lease has become invalid, then no new lease will be acquired.
     *
     * @throws LeaseException if a valid lease isn't held.
     */
    void ensureValid() throws LeaseException;
}