adorsys/datasafe

package de.adorsys.datasafe.directory.api.profile.operations;

import de.adorsys.datasafe.directory.api.types.CreateUserPrivateProfile;
import de.adorsys.datasafe.directory.api.types.CreateUserPublicProfile;
import de.adorsys.datasafe.directory.api.types.UserPrivateProfile;
import de.adorsys.datasafe.encrypiton.api.types.UserIDAuth;

/**
 * Registers user in system.
 */
public interface ProfileRegistrationService {

    /**
     * Registers public part of user's profile - his INBOX and where are his public keys.
     * IMPORTANT: For cases when user profile is stored on S3 without object locks, this requires some global
     * synchronization due to eventual consistency or you need to supply globally unique username on registration.
     * @param profile Public profile part
     */
    void registerPublic(CreateUserPublicProfile profile);

    /**
     * Registers private part of user profile - his keystore location, private folder location, etc.
     * IMPORTANT: For cases when user profile is stored on S3 without object locks, this requires some global
     * synchronization due to eventual consistency or you need to supply globally unique username on registration.
     * @param profile Private profile part
     */
    void registerPrivate(CreateUserPrivateProfile profile);

    /**
     * Creates document and optionally storage keystore and publishes his public keys according to his
     * {@link de.adorsys.datasafe.directory.api.types.UserPrivateProfile}
     * @param user Keystore owner
     * @param profile Associate profile with this keystore
     */
    void createAllAllowableKeystores(UserIDAuth user, UserPrivateProfile profile);

    /**
     * Creates document keystore according to his
     * {@link de.adorsys.datasafe.directory.api.types.UserPrivateProfile}
     * @param user Keystore owner
     */
    void createDocumentKeystore(UserIDAuth user, UserPrivateProfile profile);

    /**
     * Creates storage keystore according to his
     * {@link de.adorsys.datasafe.directory.api.types.UserPrivateProfile}
     * @param user Keystore owner
     */
    void createStorageKeystore(UserIDAuth user);

    /**
     * Register user using all-default values.
     * IMPORTANT: For cases when user profile is stored on S3 without object locks, this requires some global
     * synchronization due to eventual consistency or you need to supply globally unique username on registration.
     * @param user User authorization to register
     */
    void registerUsingDefaults(UserIDAuth user);
}