org.keycloak.credential.UserCredentialStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keycloak-server-spi Show documentation
There is a newer version: 26.1.4
/*
 * Copyright 2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.keycloak.credential;

import org.keycloak.models.RealmModel;
import org.keycloak.models.UserModel;
import org.keycloak.provider.Provider;

import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

/**
 * @author Bill Burke
 * @version $Revision: 1 $
 */
public interface UserCredentialStore extends Provider {
    void updateCredential(RealmModel realm, UserModel user, CredentialModel cred);
    CredentialModel createCredential(RealmModel realm, UserModel user, CredentialModel cred);

    /**
     * Removes credential with the {@code id} for the {@code user}.
     *
     * @param realm realm.
     * @param user user
     * @param id id
     * @return {@code true} if the credential was removed, {@code false} otherwise
     *
     * TODO: Make this method return Boolean so that store can return "I don't know" answer, this can be used for example in async stores
     */
    boolean removeStoredCredential(RealmModel realm, UserModel user, String id);
    CredentialModel getStoredCredentialById(RealmModel realm, UserModel user, String id);

    /**
     * @deprecated Use {@link #getStoredCredentialsStream(RealmModel, UserModel) getStoredCredentialsStream} instead.
     */
    @Deprecated
    List getStoredCredentials(RealmModel realm, UserModel user);

    /**
     * Obtains the stored credentials associated with the specified user.
     *
     * @param realm a reference to the realm.
     * @param user the user whose credentials are being searched.
     * @return a non-null {@link Stream} of credentials.
     */
    default Stream getStoredCredentialsStream(RealmModel realm, UserModel user) {
        List result = this.getStoredCredentials(realm, user);
        return result != null ? result.stream() : Stream.empty();
    }

    /**
     * @deprecated Use {@link #getStoredCredentialsByTypeStream(RealmModel, UserModel, String) getStoredCredentialsByTypeStream}
     * instead.
     */
    @Deprecated
    List getStoredCredentialsByType(RealmModel realm, UserModel user, String type);

    /**
     * Obtains the stored credentials associated with the specified user that match the specified type.
     *
     * @param realm a reference to the realm.
     * @param user the user whose credentials are being searched.
     * @param type the type of credentials being searched.
     * @return a non-null {@link Stream} of credentials.
     */
    default Stream getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type) {
        List result = this.getStoredCredentialsByType(realm, user, type);
        return result != null ? result.stream() : Stream.empty();
    }

    CredentialModel getStoredCredentialByNameAndType(RealmModel realm, UserModel user, String name, String type);

    //list operations
    boolean moveCredentialTo(RealmModel realm, UserModel user, String id, String newPreviousCredentialId);

    /**
     * The {@link UserCredentialStore.Streams} interface makes all collection-based methods in {@link UserCredentialStore}
     * default by providing implementations that delegate to the {@link Stream}-based variants instead of the other way around.
     * 
     * It allows for implementations to focus on the {@link Stream}-based approach for processing sets of data and benefit
     * from the potential memory and performance optimizations of that approach.
     */
    interface Streams extends UserCredentialStore {
        @Override
        default List getStoredCredentials(RealmModel realm, UserModel user) {
            return this.getStoredCredentialsStream(realm, user).collect(Collectors.toList());
        }

        @Override
        Stream getStoredCredentialsStream(RealmModel realm, UserModel user);

        @Override
        default List getStoredCredentialsByType(RealmModel realm, UserModel user, String type) {
            return this.getStoredCredentialsByTypeStream(realm, user, type).collect(Collectors.toList());
        }

        @Override
        Stream getStoredCredentialsByTypeStream(RealmModel realm, UserModel user, String type);
    }
}