/*
 * 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.csrf;

import java.io.Serial;

import jakarta.servlet.http.HttpServletRequest;
import org.jspecify.annotations.Nullable;

/**
 * Thrown when an expected {@link CsrfToken} exists, but it does not match the value
 * present on the {@link HttpServletRequest}
 *
 * @author Rob Winch
 * @since 3.2
 */
public class InvalidCsrfTokenException extends CsrfException {

	@Serial
	private static final long serialVersionUID = -7745955098435417418L;

	/**
	 * @param expectedAccessToken
	 * @param actualAccessToken
	 */
	public InvalidCsrfTokenException(CsrfToken expectedAccessToken, @Nullable String actualAccessToken) {
		super("Invalid CSRF Token '" + actualAccessToken + "' was found on the request parameter '"
				+ expectedAccessToken.getParameterName() + "' or header '" + expectedAccessToken.getHeaderName()
				+ "'.");
	}

}
