io.muserver.openapi

Class SecurityRequirementObjectBuilder

java.lang.Object

io.muserver.openapi.SecurityRequirementObjectBuilder

public class SecurityRequirementObjectBuilder
extends Object

Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the SecuritySchemeObject under the ComponentsObject.

Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information.

When a list of Security Requirement Objects is defined on the OpenAPIObject or OperationObject, only one of Security Requirement Objects in the list needs to be satisfied to authorize the request.

Constructor Summary

Constructors

Constructor and Description
SecurityRequirementObjectBuilder()

Method Summary

Modifier and Type	Method and Description
SecurityRequirementObject	build()
static SecurityRequirementObjectBuilder	securityRequirementObject() Creates a builder for a SecurityRequirementObjectBuilder
SecurityRequirementObjectBuilder	withRequirements(Map<String,List<String>> requirements)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SecurityRequirementObjectBuilder

public SecurityRequirementObjectBuilder()

Method Detail

withRequirements

public SecurityRequirementObjectBuilder withRequirements(Map<String,List<String>> requirements)

Parameters:

requirements - Each name MUST correspond to a security scheme which is declared in the ComponentsObject.securitySchemes under the ComponentsObject. If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.

Returns:

The builder

build

public SecurityRequirementObject build()

securityRequirementObject

public static SecurityRequirementObjectBuilder securityRequirementObject()

Creates a builder for a SecurityRequirementObjectBuilder

Returns:

A new builder