io.apicurio.datamodels.core.models.common

Class OAuthFlow

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.ExtensibleNode

io.apicurio.datamodels.core.models.common.OAuthFlow

All Implemented Interfaces:

IVisitable

Direct Known Subclasses:

AuthorizationCodeOAuthFlow, ClientCredentialsOAuthFlow, ImplicitOAuthFlow, PasswordOAuthFlow

public abstract class OAuthFlow
extends ExtensibleNode

Models an OAuth Flow.

Author:

eric.wittmann@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
String	authorizationUrl
String	refreshUrl
Map<String,String>	scopes
String	tokenUrl

Fields inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

_extensions

Fields inherited from class io.apicurio.datamodels.core.models.Node

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
OAuthFlow() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addScope(String scope, String description) Adds a scope.
List<String>	getScopes() Gets the list of scopes.
void	removeScope(String scope) Removes a scope.

Methods inherited from class io.apicurio.datamodels.core.models.ExtensibleNode

addExtension, clearExtensions, createExtension, getExtension, getExtensions, isExtensible, removeExtension

Methods inherited from class io.apicurio.datamodels.core.models.Node

accept, addExtraProperty, addValidationProblem, clearAttributes, clearValidationProblems, getAttribute, getAttributeNames, getExtraProperty, getExtraPropertyNames, getValidationProblemCodes, getValidationProblems, getValidationProblemsFor, hasExtraProperties, modelId, ownerDocument, parent, removeExtraProperty, setAttribute

Methods inherited from class java.lang.Object

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

Field Detail

authorizationUrl

public String authorizationUrl

tokenUrl

public String tokenUrl

refreshUrl

public String refreshUrl

scopes

public Map<String,String> scopes

Constructor Detail

OAuthFlow

public OAuthFlow()

Constructor.

Method Detail

addScope

public void addScope(String scope,
                     String description)

Adds a scope.

Parameters:

scope -

description -

removeScope

public void removeScope(String scope)

Removes a scope.

Parameters:

scope -

getScopes

public List<String> getScopes()

Gets the list of scopes.