com.palantir.lock.v2.TimelockService Maven / Gradle / Ivy

Go to download
/*
 * (c) Copyright 2019 Palantir Technologies Inc. All rights reserved.
 *
 * 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 com.palantir.lock.v2;

import com.palantir.logsafe.Safe;
import com.palantir.processors.AutoDelegate;
import com.palantir.processors.DoNotDelegate;
import com.palantir.timestamp.TimestampRange;
import java.util.List;
import java.util.Set;
import javax.ws.rs.QueryParam;

@AutoDelegate
public interface TimelockService {
    /**
     * Used for TimelockServices that can be initialized asynchronously (i.e. those extending
     * {@link com.palantir.async.initializer.AsyncInitializer}; other TimelockServices can keep the default
     * implementation, and return true (they're trivially fully initialized).
     *
     * @return true iff the TimelockService has been fully initialized and is ready to use
     */
    @DoNotDelegate
    default boolean isInitialized() {
        return true;
    }

    long getFreshTimestamp();

    long getCommitTimestamp(long startTs, LockToken commitLocksToken);

    TimestampRange getFreshTimestamps(@Safe @QueryParam("number") int numTimestampsRequested);

    // TODO (jkong): Can this be deprecated? Are there users outside of Atlas transactions?
    LockImmutableTimestampResponse lockImmutableTimestamp();

    List startIdentifiedAtlasDbTransactionBatch(int count);

    long getImmutableTimestamp();

    LockResponse lock(LockRequest request);

    WaitForLocksResponse waitForLocks(WaitForLocksRequest request);

    Set refreshLockLeases(Set tokens);

    /**
     * Releases locks associated with the set of {@link LockToken}s provided.
     * The set of tokens returned are the tokens for which the associated locks were unlocked in this call.
     * It is possible that a token that was provided is NOT in the returned set (e.g. if it expired).
     * However, in this case it is guaranteed that that token is no longer valid.
     *
     * @param tokens Tokens for which associated locks should be unlocked.
     * @return Tokens for which associated locks were unlocked
     */
    Set unlock(Set tokens);

    /**
     * A version of {@link TimelockService#unlock(Set)} where one does not need to know whether the locks associated
     * with the provided tokens were successfully unlocked or not.
     *
     * In some implementations, this may be more performant than a standard unlock.
     *
     * @param tokens Tokens for which associated locks should be unlocked.
     */
    void tryUnlock(Set tokens);

    long currentTimeMillis();
}