com.bazaarvoice.emodb.auth.identity.AuthIdentityManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of emodb-auth-core Show documentation

There is a newer version: 6.5.190

package com.bazaarvoice.emodb.auth.identity;

/**
 * Manager for identities.
 */
public interface AuthIdentityManager extends AuthIdentityReader {

    /**
     * Creates an identity.
     * @return The unique ID for the new identity
     * @throws IdentityExistsException if either the provided ID or authentication ID are already in use.
     */
    String createIdentity(String authenticationId, AuthIdentityModification modification)
            throws IdentityExistsException;
    
    /**
     * Updates an identity.
     */
    void updateIdentity(String id, AuthIdentityModification modification)
            throws IdentityNotFoundException;

    /**
     * Migrates an identity to a new authentication ID.
     * @throws IdentityNotFoundException if no identity matching the ID exists
     * @throws IdentityExistsException if another identity matching the authentication ID exists
     */
    void migrateIdentity(String id, String newAuthenticationId)
            throws IdentityNotFoundException, IdentityExistsException;

    /**
     * Deletes an identity.
     */
    void deleteIdentity(String id);
}