UserRepository.java

/* 
 * 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.ngrinder.user.repository;

import org.ngrinder.model.Role;
import org.ngrinder.model.User;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.Specification;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import java.util.List;

/**
 * User repository.
 *
 * @author JunHo Yoon
 * @since 3.0
 */
@Repository
public interface UserRepository extends JpaRepository<User, Long> {
	/**
	 * Find all {@link User}s based on the given spec.
	 *
	 * @param spec spec
	 * @return found {@link User} list
	 */
	public List<User> findAll(Specification<User> spec);


	/**
	 * Find all {@link User}s for the given role.
	 *
	 * @param role role
	 * @param sort sort
	 * @return found {@link User} list
	 */
	public List<User> findAllByRole(Role role, Sort sort);

	/**
	 * Find all {@link User}s for the given role.
	 *
	 * @param role     role
	 * @param pageable pageable
	 * @return found {@link User} list
	 */
	public Page<User> findAllByRole(Role role, Pageable pageable);


	/**
	 * Find one {@link User} by the given userId.
	 *
	 * @param userId user id
	 * @return found {@link User}. null if not found.
	 */
	public User findOneByUserId(String userId);


	/**
	 * Find users who are matching to given spec with paging.
	 *
	 * @param spec     spec
	 * @param pageable pageable
	 * @return user list
	 */
	public Page<User> findAll(Specification<User> spec, Pageable pageable);

}