/*
 * Copyright 2002-2021 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.saml2.provider.service.web;

import jakarta.servlet.http.HttpServletRequest;

import org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration;

/**
 * A contract for resolving a {@link RelyingPartyRegistration} from the HTTP request
 *
 * @author Josh Cummings
 * @since 5.6
 */
public interface RelyingPartyRegistrationResolver {

	/**
	 * Resolve a {@link RelyingPartyRegistration} from the HTTP request, using the
	 * {@code relyingPartyRegistrationId}, if it is provided
	 * @param request the HTTP request
	 * @param relyingPartyRegistrationId the {@link RelyingPartyRegistration} identifier
	 * @return the resolved {@link RelyingPartyRegistration}
	 */
	RelyingPartyRegistration resolve(HttpServletRequest request, String relyingPartyRegistrationId);

}
