com.payneteasy.superfly.password.SaltSource Maven / Gradle / Ivy

Go to download
package com.payneteasy.superfly.password;

import com.payneteasy.superfly.spisupport.SaltGenerator;

/**
 * Supplies salt values. That salt is used by {@link PasswordEncoder} instances.
 * This is intended to be stable (i.e. it should return the same instance for
 * the same argument), unlike {@link SaltGenerator} which generates new value
 * on each call.
 * 
 * @author Roman Puchkovskiy
 * @see PasswordEncoder
 */
public interface SaltSource {
    /**
     * Returns salt value.
     *
     * @param username    username for which to get salt
     * @return salt
     */
    String getSalt(String username);

    /**
     * Returns salt value by user id.
     *
     * @param userId    ID of a user
     * @return salt
     */
    String getSalt(long userId);
}