io.muserver.openapi

Class OAuthFlowObjectBuilder

java.lang.Object

io.muserver.openapi.OAuthFlowObjectBuilder

public class OAuthFlowObjectBuilder
extends Object

Configuration details for a supported OAuth Flow

Constructor Summary

Constructors

Constructor and Description
OAuthFlowObjectBuilder()

Method Summary

Modifier and Type	Method and Description
OAuthFlowObject	build()
static OAuthFlowObjectBuilder	oAuthFlowObject() Creates a builder for an OAuthFlowObject
OAuthFlowObjectBuilder	withAuthorizationUrl(URI authorizationUrl)
OAuthFlowObjectBuilder	withRefreshUrl(URI refreshUrl)
OAuthFlowObjectBuilder	withScopes(Map<String,String> scopes)
OAuthFlowObjectBuilder	withTokenUrl(URI tokenUrl)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthFlowObjectBuilder

public OAuthFlowObjectBuilder()

Method Detail

withAuthorizationUrl

public OAuthFlowObjectBuilder withAuthorizationUrl(URI authorizationUrl)

Parameters:

authorizationUrl - REQUIRED. The authorization URL to be used for this flow.

Returns:

The current builder

withTokenUrl

public OAuthFlowObjectBuilder withTokenUrl(URI tokenUrl)

Parameters:

tokenUrl - REQUIRED. The token URL to be used for this flow. This MUST be in the form of a URL.

Returns:

The current builder

withRefreshUrl

public OAuthFlowObjectBuilder withRefreshUrl(URI refreshUrl)

Parameters:

refreshUrl - The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.

Returns:

The current builder

withScopes

public OAuthFlowObjectBuilder withScopes(Map<String,String> scopes)

Parameters:

scopes - REQUIRED. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.

Returns:

The current builder

build

public OAuthFlowObject build()

oAuthFlowObject

public static OAuthFlowObjectBuilder oAuthFlowObject()

Creates a builder for an OAuthFlowObject

Returns:

A new builder