/*
 * Copyright 2004-present the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.security.web.webauthn.management;

import org.jspecify.annotations.Nullable;

import org.springframework.security.web.webauthn.api.Bytes;
import org.springframework.security.web.webauthn.api.PublicKeyCredentialUserEntity;

/**
 * A repository for managing {@link PublicKeyCredentialUserEntity} instances.
 *
 * @author Rob Winch
 * @since 6.4
 */
public interface PublicKeyCredentialUserEntityRepository {

	/**
	 * Finds the {@link PublicKeyCredentialUserEntity} by
	 * {@link PublicKeyCredentialUserEntity#getId()}
	 * @param id the id to lookup the username by
	 * @return the username or null if not found.
	 */
	@Nullable PublicKeyCredentialUserEntity findById(Bytes id);

	/**
	 * Finds the {@link PublicKeyCredentialUserEntity} by the username.
	 * @param username the username to lookup the {@link PublicKeyCredentialUserEntity}
	 * @return the {@link PublicKeyCredentialUserEntity} or null if not found.
	 */
	@Nullable PublicKeyCredentialUserEntity findByUsername(String username);

	/**
	 * Saves the {@link PublicKeyCredentialUserEntity} to the associated username.
	 * @param userEntity the {@link PublicKeyCredentialUserEntity} to associate to the
	 * provided username. If null, any existing entry is deleted.
	 */
	void save(PublicKeyCredentialUserEntity userEntity);

	void delete(Bytes id);

}
