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

import java.util.function.Supplier;

import org.jspecify.annotations.Nullable;

import org.springframework.aop.framework.AopInfrastructureBean;
import org.springframework.expression.EvaluationContext;
import org.springframework.expression.ExpressionParser;
import org.springframework.security.core.Authentication;

/**
 * Facade which isolates Spring Security's requirements for evaluating security
 * expressions from the implementation of the underlying expression objects
 *
 * @author Luke Taylor
 * @author Evgeniy Cheban
 * @since 3.1
 */
public interface SecurityExpressionHandler<T> extends AopInfrastructureBean {

	/**
	 * @return an expression parser for the expressions used by the implementation.
	 */
	ExpressionParser getExpressionParser();

	/**
	 * Provides an evaluation context in which to evaluate security expressions for the
	 * invocation type.
	 */
	EvaluationContext createEvaluationContext(@Nullable Authentication authentication, T invocation);

	/**
	 * Provides an evaluation context in which to evaluate security expressions for the
	 * invocation type. You can override this method in order to provide a custom
	 * implementation that uses lazy initialization of the {@link Authentication} object.
	 * By default, this method uses eager initialization of the {@link Authentication}
	 * object.
	 * @param authentication the {@link Supplier} of the {@link Authentication} to use
	 * @param invocation the {@link T} to use
	 * @return the {@link EvaluationContext} to use
	 * @since 5.8
	 */
	default EvaluationContext createEvaluationContext(Supplier<? extends @Nullable Authentication> authentication,
			T invocation) {
		return createEvaluationContext(authentication.get(), invocation);
	}

}
