com.palantir.lock.ExpiringToken Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lock-api-objects Show documentation

Palantir open source project

There is a newer version: 0.1193.0

/*
 * (c) Copyright 2018 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;

import com.google.common.primitives.Longs;
import java.util.Comparator;
import javax.annotation.Nullable;

/**
 * A lock server token with an expiration date.
 *
 * @author jtamer
 */
public interface ExpiringToken {

    /**
     * Returns the time (in milliseconds since the epoch) since this token was
     * created.
     */
    long getCreationDateMs();

    /**
     * Returns the time, in milliseconds since the epoch, when this token will
     * expire and become invalid.
     */
    long getExpirationDateMs();

    /**
     * Returns the client who holds these locks, or {@code null} if this
     * represents a lock grant.
     */
    @Nullable
    LockClient getClient();

    /**
     * Returns the set of locks which were successfully acquired as a map
     * from descriptor to lock mode.
     */
    SortedLockCollection getLockDescriptors();

    /**
     * Returns the amount of time that it takes for these locks to
     * expire.
     */
    TimeDuration getLockTimeout();

    /**
     * Returns the version ID for this token, or {@code null} if no version ID
     * was specified.
     */
    @Nullable
    Long getVersionId();

    /** A comparator which uses an {@code ExpiringToken}'s expiration date. */
    Comparator COMPARATOR =
            (o1, o2) -> Longs.compare(o1.getExpirationDateMs(), o2.getExpirationDateMs());
}