keystore/java/android/security/KeyChainAliasCallback.java

/*
 * Copyright (C) 2011 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;

import android.annotation.SuppressLint;
import android.annotation.Nullable;
import android.annotation.FlaggedApi;

/** The KeyChainAliasCallback is the callback for {@link KeyChain#choosePrivateKeyAlias}. */
public interface KeyChainAliasCallback {

    /**
     * Called with the alias of the certificate chosen by the user, or
     * null if no value was chosen.
     */
    public void alias(@Nullable String alias);

    /** Called with the error code of the certificate selection. */
    @FlaggedApi(android.app.admin.flags.Flags.FLAG_KEYCHAIN_SUPPRESS_CERTIFICATE_SELECTIONS)
    default void onError(@KeyChain.SelectionError int errorCode) {
        alias(null);
    }
}