org.ligoj.bootstrap.dao.system.SystemApiTokenRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bootstrap-business Show documentation

There is a newer version: 3.1.26

/*
 * Licensed under MIT (https://github.com/ligoj/ligoj/blob/master/LICENSE)
 */
package org.ligoj.bootstrap.dao.system;

import java.util.List;

import org.ligoj.bootstrap.core.dao.RestRepository;
import org.ligoj.bootstrap.model.system.SystemApiToken;
import org.springframework.data.jpa.repository.Query;

/**
 * API token repository.
 */
public interface SystemApiTokenRepository extends RestRepository {

	/**
	 * Return the name of the token matching the user.
	 * 
	 * @param user The requested user.
	 * @param hash The requested hashed API token.
	 * @return true when there is match between user and API token.
	 */
	@Query("SELECT CASE WHEN count(user) > 0 THEN true ELSE false END "
			+ "FROM SystemApiToken WHERE user=:user AND hash=:hash")
	boolean checkByUserAndHash(String user, String hash);

	/**
	 * Return the name of the token matching the user. Used for plain text token, without hash.
	 * 
	 * @param user  The requested user.
	 * @param token The requested plain text/unsecured API token.
	 * @return true when there is match between user and API token.
	 */
	@Query("SELECT CASE WHEN count(user) > 0 THEN true ELSE false END "
			+ "FROM SystemApiToken WHERE user=:user AND hash ='_plain_' AND token=:token")
	boolean checkByUserAndToken(String user, String token);

	/**
	 * Return the token entity matching the name and the user.
	 * 
	 * @param user The owner.
	 * @param name The API name.
	 * @return Matching entity or null.
	 */
	SystemApiToken findByUserAndName(String user, String name);

	/**
	 * Return all API token names of given user.
	 * 
	 * @param user The owner.
	 * @return Owned API token names.
	 */
	@Query("SELECT name FROM SystemApiToken WHERE user=?1 ORDER BY name")
	List findAllByUser(String user);

	/**
	 * Delete the token entity matching the name and the user.
	 * 
	 * @param user The owner.
	 * @param name The API name.
	 */
	void deleteByUserAndName(String user, String name);
}