/*
 * 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.oauth2.server.authorization.context;

import org.springframework.security.oauth2.server.authorization.settings.AuthorizationServerSettings;

/**
 * A context that holds information of the Authorization Server runtime environment.
 *
 * @author Joe Grandja
 * @since 7.0
 * @see AuthorizationServerSettings
 * @see AuthorizationServerContextHolder
 */
public interface AuthorizationServerContext {

	/**
	 * Returns {@link AuthorizationServerSettings#getIssuer()} if available, otherwise,
	 * resolves the issuer identifier from the <i>"current"</i> request.
	 *
	 * <p>
	 * The issuer identifier may contain a path component to support
	 * {@link AuthorizationServerSettings#isMultipleIssuersAllowed() multiple issuers per
	 * host} in a multi-tenant hosting configuration.
	 *
	 * <p>
	 * For example:
	 * <ul>
	 * <li>{@code https://example.com/issuer1/oauth2/token} &mdash; resolves the issuer to
	 * {@code https://example.com/issuer1}</li>
	 * <li>{@code https://example.com/issuer2/oauth2/token} &mdash; resolves the issuer to
	 * {@code https://example.com/issuer2}</li>
	 * <li>{@code https://example.com/authz/issuer1/oauth2/token} &mdash; resolves the
	 * issuer to {@code https://example.com/authz/issuer1}</li>
	 * <li>{@code https://example.com/authz/issuer2/oauth2/token} &mdash; resolves the
	 * issuer to {@code https://example.com/authz/issuer2}</li>
	 * </ul>
	 * @return {@link AuthorizationServerSettings#getIssuer()} if available, otherwise,
	 * resolves the issuer identifier from the <i>"current"</i> request
	 */
	String getIssuer();

	/**
	 * Returns the {@link AuthorizationServerSettings}.
	 * @return the {@link AuthorizationServerSettings}
	 */
	AuthorizationServerSettings getAuthorizationServerSettings();

}
