org.eclipse.microprofile.openapi.models.security

Interface Scopes

All Superinterfaces:

Constructible, Extensible<Scopes>, Map<String,String>

Deprecated.

a future version will remove this and replace it with a Map<String, String>, because it does not need to be extensibles

@Deprecated
public interface Scopes
extends Constructible, Extensible<Scopes>, Map<String,String>

Scopes is a property of OAuth Flow Object.

See Also:

OAuthFlow Object

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
Scopes	addScope(String scope, String description) Deprecated. Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.
boolean	containsKey(Object key) Deprecated. since 1.1
String	get(Object key) Deprecated. since 1.1
default String	getScope(String scope) Deprecated. Returns a scope description for a given scope name.
Map<String,String>	getScopes() Deprecated. Returns a copy map (potentially immutable) of scopes.
default boolean	hasScope(String scope) Deprecated. Check whether a scope item is present in the map.
String	put(String key, String value) Deprecated. since 1.1
void	putAll(Map<? extends String,? extends String> m) Deprecated. since 1.1
String	remove(Object key) Deprecated. since 1.1
void	removeScope(String scope) Deprecated. Removes the given scope item to this Scopes.
void	setScopes(Map<String,String> items) Deprecated. Set the scope items map to this Scopes

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

addExtension, extensions, getExtensions, removeExtension, setExtensions

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

Method Detail

addScope

Scopes addScope(String scope,
                String description)

Deprecated.

Adds name of an existing scope object and item parameters to a Scopes instance as a key-value pair in a map.

Parameters:

scope - the name of a scope

description - description of the scope.

Returns:

Scopes instance with the added key-value pair

removeScope

void removeScope(String scope)

Deprecated.

Removes the given scope item to this Scopes.

Parameters:

scope - the name of a scope

getScopes

Map<String,String> getScopes()

Deprecated.

Returns a copy map (potentially immutable) of scopes.

Returns:

all items

setScopes

void setScopes(Map<String,String> items)

Deprecated.

Set the scope items map to this Scopes

Parameters:

items - key-value pair in a map.

hasScope

default boolean hasScope(String scope)

Deprecated.

Check whether a scope item is present in the map. This is a convenience method for getScopes().containsKey(name)

Parameters:

scope - the name of a scope.

Returns:

a boolean to indicate if the scope item is present or not.

getScope

default String getScope(String scope)

Deprecated.

Returns a scope description for a given scope name. This is a convenience method for getScopes().get(name)

Parameters:

scope - the name of a scope.

Returns:

the corresponding description or null.

get

@Deprecated
String get(Object key)

Deprecated. since 1.1

In the next version, Scopes will no longer extends Map, this method will no longer be present. Use getScope(String) instead.

Specified by:

get in interface Map<String,String>

containsKey

@Deprecated
boolean containsKey(Object key)

Deprecated. since 1.1

In the next version, Scopes will no longer extends Map, this method will no longer be present. Use hasScope(String) instead.

Specified by:

containsKey in interface Map<String,String>

put

@Deprecated
String put(String key,
                       String value)

Deprecated. since 1.1

In the next version, Scopes will no longer extends Map, this method will no longer be present. Use addScope(String, String) instead.

Specified by:

put in interface Map<String,String>

putAll

@Deprecated
void putAll(Map<? extends String,? extends String> m)

Deprecated. since 1.1

In the next version, Scopes will no longer extends Map, this method will no longer be present. Use setScopes(Map) instead.

Specified by:

putAll in interface Map<String,String>

remove

@Deprecated
String remove(Object key)

Deprecated. since 1.1

In the next version, Scopes will no longer extends Map, this method will no longer be present. Use removeScope(String) instead.

Specified by:

remove in interface Map<String,String>