org.graylog2.cluster.lock.LockService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.0.5
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * 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
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog2.cluster.lock;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Optional;

public interface LockService {
    /**
     * Request a lock. If a lock already exists, the lock expiry time will be extended.
     *
     * @param resource Unique identifier for the resource that should be guarded by this lock.
     * @param lockContext  an identifier that will be appended to the callers' node id. This will create the lock owner string.
     *                       A context can be used for resources that should only allow a single lock to be acquired, even from the same node.
     *                       If the lockContext is null, only the nodeId will be used.
     * @return A {@link Lock} object, if a lock was obtained. An empty {@link Optional}, if no lock could be acquired.
     */
    Optional lock(@Nonnull String resource, @Nullable String lockContext);

    /**
     * Request a lock. If a lock already exists, the lock expiry time will be extended.
     *
     * @param resource Unique identifier for the resource that should be guarded by this lock.
     * @return A {@link Lock} object, if a lock was obtained. An empty {@link Optional}, if no lock could be acquired.
     */
    Optional lock(@Nonnull String resource);

    /**
     * Extend the expiry time of an existing lock.
     *
     * @param existingLock the lock that should be extended.
     * @return A {@link Lock} object, if the lock could be extended. An empty {@link Optional}, if no lock extension could be acquired.
     */
    Optional extendLock(@Nonnull Lock existingLock);


    /**
     * Unlock an existing lock.
     *
     * @param resource Unique identifier for the resource that was guarded by this lock.
     * @param lockContext the lockContext that was used to guard this lock.
     * @return A {@link Lock} object, if the lock could be unlocked. An empty {@link Optional}, if no lock was found.
     */
    Optional unlock(@Nonnull String resource, @Nullable String lockContext);

    /**
     * Unlock an existing lock.
     * @param lock The lock to unlock.
     * @return A {@link Lock} object, if the lock could be unlocked. An empty {@link Optional}, if no lock was found.
     */
    Optional unlock(Lock lock);
}