TokenVerificationService.java

/*
 * Copyright 2026 Global Crop Diversity Trust
 * Licensed under the Apache License, Version 2.0
 * See LICENSE file in project root folder or http://www.apache.org/licenses/LICENSE-2.0
 */

package org.gringlobal.service;

import org.gringlobal.model.VerificationToken;

/**
 * @author Maxym Borodenko
 */
public interface TokenVerificationService {

	/**
	 * Generate a new verification token (uuid+key) for specified tokenPurpose
	 *
	 * @param tokenPurpose
	 * @param data
	 * @return
	 */
	VerificationToken generateToken(String tokenPurpose, String data);

	/**
	 * Cancel (remove) token
	 *
	 * @param tokenUuid
	 * @throws NoSuchVerificationTokenException
	 */
	void cancel(String tokenUuid) throws NoSuchVerificationTokenException;

	/**
	 * Fetch the token
	 *
	 * @param purpose
	 * @param tokenUuid
	 * @throws NoSuchVerificationTokenException
	 *
	 * @return
	 */
	VerificationToken fetchToken(String purpose, String tokenUuid) throws NoSuchVerificationTokenException;

	/**
	 * Check token validity, remove it from persistence
	 *
	 * @param purpose
	 * @param tokenUuid
	 * @param key
	 * @return The consumed token
	 * @throws NoSuchVerificationTokenException
	 */
	VerificationToken consumeToken(String purpose, String tokenUuid, String key) throws NoSuchVerificationTokenException, TokenExpiredException;

	/**
	 * Removes expired verification tokens
	 */
	void removeExpired();

	/**
	 * The NoSuchVerificationTokenException class.
	 */
	class NoSuchVerificationTokenException extends Exception {

		/** The Constant serialVersionUID. */
		private static final long serialVersionUID = 8783400912935658736L;
	}

	/**
	 * The TokenExpiredException class.
	 */
	class TokenExpiredException extends Exception {

		/** The Constant serialVersionUID. */
		private static final long serialVersionUID = -2657527214934392747L;
	}
}