001/**
002 *
003 * Copyright 2018 Paul Schaub.
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.jivesoftware.smackx.ox.callback.backup;
018
019import java.util.Set;
020
021import org.pgpainless.key.OpenPgpV4Fingerprint;
022
023
024/**
025 * Callback to allow the user to decide, which locally available secret keys they want to include in a backup.
026 */
027public interface SecretKeyBackupSelectionCallback {
028
029    /**
030     * Let the user decide, which secret keys they want to backup.
031     *
032     * @param availableSecretKeys {@link Set} of {@link OpenPgpV4Fingerprint}s of locally available
033     *                                       OpenPGP secret keys.
034     * @return {@link Set} which contains the {@link OpenPgpV4Fingerprint}s the user decided to include
035     *                                       in the backup.
036     */
037    Set<OpenPgpV4Fingerprint> selectKeysToBackup(Set<OpenPgpV4Fingerprint> availableSecretKeys);
038}