/*
 * Copyright 2002-2023 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.metadata;

import jakarta.servlet.http.HttpServletRequest;

/**
 * Resolves Relying Party SAML 2.0 Metadata given details from the
 * {@link HttpServletRequest}.
 *
 * @author Josh Cummings
 * @since 6.1
 */
public interface Saml2MetadataResponseResolver {

	/**
	 * Construct and serialize a relying party's SAML 2.0 metadata based on the given
	 * {@link HttpServletRequest}
	 * @param request the HTTP request
	 * @return a {@link Saml2MetadataResponse} instance
	 */
	Saml2MetadataResponse resolve(HttpServletRequest request);

}
