Package com.nimbusds.oauth2.sdk

Class Scope.Value

java.lang.Object

com.nimbusds.oauth2.sdk.id.Identifier

com.nimbusds.oauth2.sdk.Scope.Value

All Implemented Interfaces:

Serializable, Comparable<Identifier>, net.minidev.json.JSONAware

Direct Known Subclasses:

OIDCScopeValue

Enclosing class:

Scope

@Immutable
public static class Scope.Value
extends Identifier

Authorisation scope value.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Scope.Value.Requirement	Enumeration of the scope value requirements for application-specific authorisation requests.

Field Summary

Fields inherited from class com.nimbusds.oauth2.sdk.id.Identifier

DEFAULT_BYTE_LENGTH, secureRandom

Constructor Summary

Constructors

Constructor	Description
Value(String value)	Creates a new scope value.
Value(String value, Scope.Value.Requirement requirement)	Creates a new scope value with an optional requirement.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
Scope.Value.Requirement	getRequirement()	Gets the requirement of this scope value.

Methods inherited from class com.nimbusds.oauth2.sdk.id.Identifier

compareTo, getValue, hashCode, toJSONString, toString, toStringList

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Value

public Value(String value)

Creates a new scope value. The requirement is not specified.

Parameters:

value - The scope value. Must not be null or empty string.

Value

public Value(String value,
 Scope.Value.Requirement requirement)

Creates a new scope value with an optional requirement.

Parameters:

value - The scope value. Must not be null or empty string.

requirement - The requirement, null if not specified.

Method Details

getRequirement

public Scope.Value.Requirement getRequirement()

Gets the requirement of this scope value.

Returns:

The requirement, null if not specified.

equals

public boolean equals(Object object)

Overrides:

equals in class Identifier