org.mitre.oauth2.service

Interface SystemScopeService

All Known Implementing Classes:

DefaultSystemScopeService

public interface SystemScopeService

Author:

jricher

Field Summary

Fields

Modifier and Type	Field and Description
static String	OFFLINE_ACCESS
static String	OPENID_SCOPE
static String	REGISTRATION_TOKEN_SCOPE
static Set<SystemScope>	reservedScopes
static String	RESOURCE_TOKEN_SCOPE
static String	UMA_AUTHORIZATION_SCOPE
static String	UMA_PROTECTION_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>	getReserved() Get all the reserved system scopes.
Set<SystemScope>	getRestricted() Get all the registered scopes that are restricted.
Set<SystemScope>	getUnrestricted() Get all the registered scopes that aren't restricted.
void	remove(SystemScope scope)
Set<SystemScope>	removeReservedScopes(Set<SystemScope> scopes) Remove any system-reserved scopes from the set and return the result.
Set<SystemScope>	removeRestrictedAndReservedScopes(Set<SystemScope> scopes) Remove any system-reserved or registered 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.
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

OPENID_SCOPE

static final String OPENID_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

UMA_PROTECTION_SCOPE

static final String UMA_PROTECTION_SCOPE

See Also:

Constant Field Values

UMA_AUTHORIZATION_SCOPE

static final String UMA_AUTHORIZATION_SCOPE

See Also:

Constant Field Values

reservedScopes

static final Set<SystemScope> reservedScopes

Method Detail

getAll

Set<SystemScope> getAll()

getDefaults

Set<SystemScope> getDefaults()

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

Returns:

getReserved

Set<SystemScope> getReserved()

Get all the reserved system scopes. These can't be used by clients directly, but are instead tied to special system tokens like id tokens and registration access tokens.

Returns:

getRestricted

Set<SystemScope> getRestricted()

Get all the registered scopes that are restricted.

Returns:

getUnrestricted

Set<SystemScope> getUnrestricted()

Get all the registered scopes that aren't restricted.

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. All scopes in "actual" must exist in "expected".

removeRestrictedAndReservedScopes

Set<SystemScope> removeRestrictedAndReservedScopes(Set<SystemScope> scopes)

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

Parameters:

scopes -

Returns:

removeReservedScopes

Set<SystemScope> removeReservedScopes(Set<SystemScope> scopes)

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

Parameters:

scopes -

Returns: