Package io.gravitee.am.service

Interface ScopeService

All Known Implementing Classes:

ScopeServiceImpl

public interface ScopeService

Author:

David BRASSELY (david.brassely at graviteesource.com), Titouan COMPIEGNE (titouan.compiegne at graviteesource.com), Alexandre FARIA (contact at alexandrefaria.net), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
default io.reactivex.rxjava3.core.Single<Scope>	create(String domain, NewScope scope)
io.reactivex.rxjava3.core.Single<Scope>	create(String domain, NewScope scope, User principal)
io.reactivex.rxjava3.core.Single<Scope>	create(String domain, NewSystemScope scope)
default io.reactivex.rxjava3.core.Completable	delete(String scopeId, boolean force)
io.reactivex.rxjava3.core.Completable	delete(String scopeId, boolean force, User principal)
io.reactivex.rxjava3.core.Single<Page<Scope>>	findByDomain(String domain, int page, int size)
io.reactivex.rxjava3.core.Maybe<Scope>	findByDomainAndKey(String domain, String scopeKey)
io.reactivex.rxjava3.core.Single<List<Scope>>	findByDomainAndKeys(String domain, List<String> scopeKeys)
io.reactivex.rxjava3.core.Maybe<Scope>	findById(String id)
default io.reactivex.rxjava3.core.Single<Scope>	patch(String domain, String id, PatchScope patchScope)
io.reactivex.rxjava3.core.Single<Scope>	patch(String domain, String id, PatchScope patchScope, User principal)
io.reactivex.rxjava3.core.Single<Page<Scope>>	search(String domain, String query, int page, int size)
default io.reactivex.rxjava3.core.Single<Scope>	update(String domain, String id, UpdateScope updateScope)
io.reactivex.rxjava3.core.Single<Scope>	update(String domain, String id, UpdateScope updateScope, User principal)
io.reactivex.rxjava3.core.Single<Scope>	update(String domain, String id, UpdateSystemScope updateScope)
io.reactivex.rxjava3.core.Single<Boolean>	validateScope(String domain, List<String> scopes)	Throw InvalidClientMetadataException if null or empty, or contains unknown scope.

Method Details

findById

io.reactivex.rxjava3.core.Maybe<Scope> findById(String id)

create

io.reactivex.rxjava3.core.Single<Scope> create(String domain,
 NewScope scope,
 User principal)

create

io.reactivex.rxjava3.core.Single<Scope> create(String domain,
 NewSystemScope scope)

findByDomain

io.reactivex.rxjava3.core.Single<Page<Scope>> findByDomain(String domain,
 int page,
 int size)

findByDomainAndKey

io.reactivex.rxjava3.core.Maybe<Scope> findByDomainAndKey(String domain,
 String scopeKey)

findByDomainAndKeys

io.reactivex.rxjava3.core.Single<List<Scope>> findByDomainAndKeys(String domain,
 List<String> scopeKeys)

patch

io.reactivex.rxjava3.core.Single<Scope> patch(String domain,
 String id,
 PatchScope patchScope,
 User principal)

update

io.reactivex.rxjava3.core.Single<Scope> update(String domain,
 String id,
 UpdateScope updateScope,
 User principal)

update

io.reactivex.rxjava3.core.Single<Scope> update(String domain,
 String id,
 UpdateSystemScope updateScope)

delete

io.reactivex.rxjava3.core.Completable delete(String scopeId,
 boolean force,
 User principal)

search

io.reactivex.rxjava3.core.Single<Page<Scope>> search(String domain,
 String query,
 int page,
 int size)

validateScope

io.reactivex.rxjava3.core.Single<Boolean> validateScope(String domain,
 List<String> scopes)

Throw InvalidClientMetadataException if null or empty, or contains unknown scope.

Parameters:

scopes - Array of scope to validate.

create

default io.reactivex.rxjava3.core.Single<Scope> create(String domain,
 NewScope scope)

patch

default io.reactivex.rxjava3.core.Single<Scope> patch(String domain,
 String id,
 PatchScope patchScope)

update

default io.reactivex.rxjava3.core.Single<Scope> update(String domain,
 String id,
 UpdateScope updateScope)

delete

default io.reactivex.rxjava3.core.Completable delete(String scopeId,
 boolean force)