Package io.gravitee.am.service

Interface MembershipService

All Known Implementing Classes:

MembershipServiceImpl

public interface MembershipService

Author:

Titouan COMPIEGNE (titouan.compiegne at graviteesource.com), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
io.reactivex.rxjava3.core.Completable	addDomainUserRoleIfNecessary(String organizationId, String environmentId, String domainId, NewMembership newMembership, User principal)	When adding membership to an application, some permissions are necessary on the application's domain.
io.reactivex.rxjava3.core.Completable	addEnvironmentUserRoleIfNecessary(String organizationId, String environmentId, NewMembership newMembership, User principal)	When adding membership to a domain, some permissions are necessary on the domain's environment.
default io.reactivex.rxjava3.core.Single<Membership>	addOrUpdate(String organizationId, Membership membership)
io.reactivex.rxjava3.core.Single<Membership>	addOrUpdate(String organizationId, Membership membership, User principal)
default io.reactivex.rxjava3.core.Completable	delete(String membershipId)
io.reactivex.rxjava3.core.Completable	delete(String membershipId, User principal)
io.reactivex.rxjava3.core.Flowable<Membership>	findByCriteria(ReferenceType referenceType, String referenceId, MembershipCriteria criteria)
io.reactivex.rxjava3.core.Maybe<Membership>	findById(String id)
io.reactivex.rxjava3.core.Flowable<Membership>	findByMember(String memberId, MemberType memberType)
io.reactivex.rxjava3.core.Flowable<Membership>	findByReference(String referenceId, ReferenceType referenceType)
io.reactivex.rxjava3.core.Single<Map<String,Map<String,Object>>>	getMetadata(List<Membership> memberships)
io.reactivex.rxjava3.core.Single<Membership>	setPlatformAdmin(String userId)

Method Details

findById

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

findByCriteria

io.reactivex.rxjava3.core.Flowable<Membership> findByCriteria(ReferenceType referenceType,
 String referenceId,
 MembershipCriteria criteria)

findByReference

io.reactivex.rxjava3.core.Flowable<Membership> findByReference(String referenceId,
 ReferenceType referenceType)

findByMember

io.reactivex.rxjava3.core.Flowable<Membership> findByMember(String memberId,
 MemberType memberType)

addOrUpdate

io.reactivex.rxjava3.core.Single<Membership> addOrUpdate(String organizationId,
 Membership membership,
 User principal)

setPlatformAdmin

io.reactivex.rxjava3.core.Single<Membership> setPlatformAdmin(String userId)

getMetadata

io.reactivex.rxjava3.core.Single<Map<String,Map<String,Object>>> getMetadata(List<Membership> memberships)

delete

io.reactivex.rxjava3.core.Completable delete(String membershipId,
 User principal)

addOrUpdate

default io.reactivex.rxjava3.core.Single<Membership> addOrUpdate(String organizationId,
 Membership membership)

delete

default io.reactivex.rxjava3.core.Completable delete(String membershipId)

addDomainUserRoleIfNecessary

io.reactivex.rxjava3.core.Completable addDomainUserRoleIfNecessary(String organizationId,
 String environmentId,
 String domainId,
 NewMembership newMembership,
 User principal)

When adding membership to an application, some permissions are necessary on the application's domain. These permissions are available through the DOMAIN_USER. For convenience, to limit the number of actions an administrator must do to affect role on an application, the group or user will also inherit the DOMAIN_USER role on the application's domain. If the group or user already has a role on the domain, nothing is done.

See Also:

• addDomainUserRoleIfNecessary(String, String, String, NewMembership, User)

addEnvironmentUserRoleIfNecessary

io.reactivex.rxjava3.core.Completable addEnvironmentUserRoleIfNecessary(String organizationId,
 String environmentId,
 NewMembership newMembership,
 User principal)

When adding membership to a domain, some permissions are necessary on the domain's environment. These permissions are available through the ENVIRONMENT_USER. For convenience, to limit the number of actions an administrator must do to affect role on a domain, the group or user will also inherit the ENVIRONMENT_USER role on the domain's environment. If the group or user already has a role on the environment, nothing is done.