identity/java/android/security/identity/AuthenticationKeyMetadata.java

/*
 * Copyright 2022 The Android Open Source Project
 *
 * 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 android.security.identity;

import android.annotation.IntRange;
import android.annotation.NonNull;

import java.time.Instant;

/**
 * Data about authentication keys.
 */
public final class AuthenticationKeyMetadata {
    private int mUsageCount;
    private Instant mExpirationDate;

    AuthenticationKeyMetadata(int usageCount, @NonNull Instant expirationDate) {
        mUsageCount = usageCount;
        mExpirationDate = expirationDate;
    }

    /**
     * Gets usage count for the authentication key.
     *
     * @return the usage count
     */
    public @IntRange(from = 0) int getUsageCount() {
        return mUsageCount;
    }

    /**
     * Gets expiration date for the authentication key.
     *
     * @return the expiration date of the authentication key.
     */
    public @NonNull Instant getExpirationDate() {
        return mExpirationDate;
    }
}