OneTimeTokenCredentialRepository.java

package org.apereo.cas.otp.repository.credentials;

import java.util.List;

/**
 * This is {@link OneTimeTokenCredentialRepository}.
 *
 * @author Misagh Moayyed
 * @since 5.1.0
 */
public interface OneTimeTokenCredentialRepository {
    /**
     * Gets secret.
     *
     * @param username the username
     * @return the secret
     */
    String getSecret(String username);

    /**
     * Save.
     *
     * @param userName       the user name
     * @param secretKey      the secret key
     * @param validationCode the validation code
     * @param scratchCodes   the scratch codes
     */
    void save(String userName, String secretKey, int validationCode, List<Integer> scratchCodes);

    /**
     * Create one time token account.
     *
     * @param username the username
     * @return the one time token account
     */
    OneTimeTokenAccount create(String username);
}