io.apicurio.datamodels.core.models.common

Class SecurityRequirement

java.lang.Object

io.apicurio.datamodels.core.models.Node

io.apicurio.datamodels.core.models.common.SecurityRequirement

All Implemented Interfaces:

IVisitable

Direct Known Subclasses:

AaiSecurityRequirement, OasSecurityRequirement

public abstract class SecurityRequirement
extends Node

Models a security requirement.

Author:

eric.wittmann@gmail.com

Field Summary

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

_attributes, _extraProperties, _modelId, _ownerDocument, _parent, _validationProblems

Constructor Summary

Constructors

Constructor and Description
SecurityRequirement() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(IVisitor visitor) Called to accept a visitor onto a visitable data model instance.
void	addSecurityRequirementItem(String name, List<String> scopes) Adds a security requirement item.
List<String>	getScopes(String name) Gets the scopes defined for this security requirement.
List<String>	getSecurityRequirementNames() Gets the names of all the security requirements.
List<String>	removeSecurityRequirementItem(String name) Removes a single security requirement item (reference to an existing security scheme) by scheme name and returns the array of scopes previously mapped to the scheme name.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityRequirement

public SecurityRequirement()

Constructor.

Method Detail

getSecurityRequirementNames

public List<String> getSecurityRequirementNames()

Gets the names of all the security requirements.

getScopes

public List<String> getScopes(String name)

Gets the scopes defined for this security requirement. This is only valid if the type of security is oauth2.

addSecurityRequirementItem

public void addSecurityRequirementItem(String name,
                                       List<String> scopes)

Adds a security requirement item.

Parameters:

name -

scopes -

removeSecurityRequirementItem

public List<String> removeSecurityRequirementItem(String name)

Removes a single security requirement item (reference to an existing security scheme) by scheme name and returns the array of scopes previously mapped to the scheme name.

Parameters:

name -

accept

public void accept(IVisitor visitor)

Description copied from interface: IVisitable

Called to accept a visitor onto a visitable data model instance.

Specified by:

accept in interface IVisitable

Specified by:

accept in class Node

See Also:

Node.accept(io.apicurio.datamodels.core.visitors.IVisitor)