Interface RoleContainerModel

All Known Subinterfaces:
CachedRealmModel, ClientModel, RealmModel, StorageProviderRealmModel
All Known Implementing Classes:
AbstractClientStorageAdapter, AbstractReadOnlyClientStorageAdapter, ClientAdapter, ClientAdapter, ClientModelLazyDelegate, ClientModelLazyDelegate.WithId, OIDCClientSecretConfigWrapper.ReadOnlyRotatedSecretClientModel, RealmAdapter, RealmAdapter, RealmModelDelegate, TypeAwareClientModelDelegate, UnsupportedOperationsClientStorageAdapter

public interface RoleContainerModel
Version:
$Revision: 1 $
Author:
Bill Burke
  • Method Details

    • getId

      String getId()
    • getRole

      RoleModel getRole(String name)
    • addRole

      RoleModel addRole(String name)
    • addRole

      RoleModel addRole(String id, String name)
    • removeRole

      boolean removeRole(RoleModel role)
    • getRolesStream

      Stream<RoleModel> getRolesStream()
      Returns available roles as a stream.
      Returns:
      Stream of RoleModel. Never returns null.
    • getRolesStream

      Stream<RoleModel> getRolesStream(Integer firstResult, Integer maxResults)
      Returns available roles as a stream.
      Parameters:
      firstResult - Integer Index of the first desired role. Ignored if negative or null.
      maxResults - Integer Maximum number of returned roles. Ignored if negative or null.
      Returns:
      Stream of RoleModel. Never returns null.
    • searchForRolesStream

      Stream<RoleModel> searchForRolesStream(String search, Integer first, Integer max)
      Searches roles by the given name. Returns all roles that match the given filter.
      Parameters:
      search - String Name of the role to be used as a filter.
      first - Integer Index of the first desired role. Ignored if negative or null.
      max - Integer Maximum number of returned roles. Ignored if negative or null.
      Returns:
      Stream of RoleModel. Never returns null.