org.mitre.oauth2.service

Interface SystemScopeService

public interface SystemScopeService

Author:

jricher

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID_TOKEN_SCOPE
static String	OFFLINE_ACCESS
static String	REGISTRATION_TOKEN_SCOPE
static String	RESOURCE_TOKEN_SCOPE

Method Summary

Modifier and Type	Method and Description
Set<SystemScope>	fromStrings(Set<String> scope) Translate the set of scope strings into a set of SystemScope objects.
Set<SystemScope>	getAll()
SystemScope	getById(Long id)
SystemScope	getByValue(String value)
Set<SystemScope>	getDefaults() Get all scopes that are defaulted to new clients on this system
Set<SystemScope>	getDynReg() Get all scopes that are allowed for dynamic registration on this system
void	remove(SystemScope scope)
Set<String>	removeRestrictedScopes(Set<String> scopes) Remove any system-restricted scopes from the set and return the result.
SystemScope	save(SystemScope scope)
boolean	scopesMatch(Set<String> expected, Set<String> actual) Test whether the scopes in both sets are compatible, with special processing for structured scopes.
Set<String>	toStrings(Set<SystemScope> scope) Pluck the scope values from the set of SystemScope objects and return a list of strings

Field Detail

OFFLINE_ACCESS

static final String OFFLINE_ACCESS

See Also:

Constant Field Values

ID_TOKEN_SCOPE

static final String ID_TOKEN_SCOPE

See Also:

Constant Field Values

REGISTRATION_TOKEN_SCOPE

static final String REGISTRATION_TOKEN_SCOPE

See Also:

Constant Field Values

RESOURCE_TOKEN_SCOPE

static final String RESOURCE_TOKEN_SCOPE

See Also:

Constant Field Values

Method Detail

getAll

Set<SystemScope> getAll()

getDefaults

Set<SystemScope> getDefaults()

Get all scopes that are defaulted to new clients on this system

Returns:

getDynReg

Set<SystemScope> getDynReg()

Get all scopes that are allowed for dynamic registration on this system

Returns:

getById

SystemScope getById(Long id)

getByValue

SystemScope getByValue(String value)

remove

void remove(SystemScope scope)

save

SystemScope save(SystemScope scope)

fromStrings

Set<SystemScope> fromStrings(Set<String> scope)

Translate the set of scope strings into a set of SystemScope objects.

Parameters:

scope -

Returns:

toStrings

Set<String> toStrings(Set<SystemScope> scope)

Pluck the scope values from the set of SystemScope objects and return a list of strings

Parameters:

scope -

Returns:

scopesMatch

boolean scopesMatch(Set<String> expected,
                    Set<String> actual)

Test whether the scopes in both sets are compatible, with special processing for structured scopes. All scopes in "actual" must exist in "expected". If a scope in "expected" is structured and has a value, it must be matched exactly by its corresponding scope in "actual". If a scope in "expected" is structured but has no value, it may be matched by a scope with or without a value in "actual".

removeRestrictedScopes

Set<String> removeRestrictedScopes(Set<String> scopes)

Remove any system-restricted scopes from the set and return the result.

Parameters:

scopes -

Returns: