net.officefloor.web.openapi.operation.OpenApiOperationContext Maven / Gradle / Ivy

Go to download
/*-
 * #%L
 * OpenAPI
 * %%
 * Copyright (C) 2005 - 2020 Daniel Sagenschneider
 * %%
 * 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
 * 
 *      http://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.
 * #L%
 */

package net.officefloor.web.openapi.operation;

import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import net.officefloor.web.build.HttpInputExplorerContext;
import net.officefloor.web.openapi.security.OpenApiSecurityExtension;

/**
 * Context for the {@link OpenApiOperationBuilder}.
 * 
 * @author Daniel Sagenschneider
 */
public interface OpenApiOperationContext {

	/**
	 * Obtains the {@link HttpInputExplorerContext}.
	 * 
	 * @return {@link HttpInputExplorerContext}.
	 */
	HttpInputExplorerContext getHttpInput();

	/**
	 * Obtains the {@link OpenAPI}.
	 * 
	 * @return {@link OpenAPI}.
	 */
	OpenAPI getOpenApi();

	/**
	 * Obtains the {@link PathItem}.
	 * 
	 * @return {@link PathItem}.
	 */
	PathItem getPath();

	/**
	 * Obtains the {@link Operation}.
	 * 
	 * @return {@link Operation}.
	 */
	Operation getOperation();

	/**
	 * Obtains the {@link Parameter} by name.
	 * 
	 * @param name Name of the {@link Parameter}.
	 * @return {@link Parameter} by name or null if none.
	 */
	Parameter getParameter(String name);

	/**
	 * 
	 * Convenience method to lazy create the {@link SecurityRequirement}.
	 * 
	 * This will return the first {@link SecurityRequirement} registered for the
	 * {@link SecurityScheme}.
	 * 
	 * @param securityName Name of {@link SecurityScheme}.
	 * @return Existing {@link SecurityRequirement} for {@link SecurityScheme} or
	 *         created {@link SecurityRequirement} if not already added.
	 */
	SecurityRequirement getOrAddSecurityRequirement(String securityName);

	/**
	 * Obtains the {@link Components}.
	 * 
	 * @return {@link Components}.
	 */
	Components getComponents();

	/**
	 * Obtains all the security names registered via the
	 * {@link OpenApiSecurityExtension} instances.
	 * 
	 * @return All the security names.
	 */
	String[] getAllSecurityNames();

}