Class MapClientProvider

    • Method Detail

      • getClientsStream

        public Stream<ClientModel> getClientsStream​(RealmModel realm,
                                                    Integer firstResult,
                                                    Integer maxResults)
        Description copied from interface: ClientProvider
        Returns the clients of the given realm as a stream.
        Specified by:
        getClientsStream in interface ClientProvider
        Parameters:
        realm - Realm.
        firstResult - First result to return. Ignored if negative or null.
        maxResults - Maximum number of results to return. Ignored if negative or null.
        Returns:
        Stream of the clients. Never returns null.
      • getClientsStream

        public Stream<ClientModel> getClientsStream​(RealmModel realm)
        Description copied from interface: ClientProvider
        Returns all the clients of the given realm as a stream. Effectively the same as the call getClientsStream(realm, null, null).
        Specified by:
        getClientsStream in interface ClientProvider
        Parameters:
        realm - Realm.
        Returns:
        Stream of the clients. Never returns null.
      • addClient

        public ClientModel addClient​(RealmModel realm,
                                     String id,
                                     String clientId)
        Description copied from interface: ClientProvider
        Adds a client with given internal ID and clientId to the given realm.
        Specified by:
        addClient in interface ClientProvider
        Parameters:
        realm - Realm owning this client.
        id - Internal ID of the client or null if one is to be created by the underlying store
        clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.
        Returns:
        Model of the created client.
      • removeClient

        public boolean removeClient​(RealmModel realm,
                                    String id)
        Description copied from interface: ClientProvider
        Removes given client from the given realm.
        Specified by:
        removeClient in interface ClientProvider
        Parameters:
        realm - Realm.
        id - Internal ID of the client
        Returns:
        true if the client existed and has been removed, false otherwise.
      • getClientsCount

        public long getClientsCount​(RealmModel realm)
        Description copied from interface: ClientProvider
        Returns number of clients in the given realm
        Specified by:
        getClientsCount in interface ClientProvider
        Parameters:
        realm - Realm.
        Returns:
        Number of the clients in the given realm.
      • getClientByClientId

        public ClientModel getClientByClientId​(RealmModel realm,
                                               String clientId)
        Description copied from interface: ClientLookupProvider
        Exact search for a client by its public client identifier.
        Specified by:
        getClientByClientId in interface ClientLookupProvider
        Parameters:
        realm - Realm to limit the search for clients.
        clientId - String that identifies the client to the external parties. Maps to client_id in OIDC or entityID in SAML.
        Returns:
        Model of the client, or null if no client is found.
      • searchClientsByClientIdStream

        public Stream<ClientModel> searchClientsByClientIdStream​(RealmModel realm,
                                                                 String clientId,
                                                                 Integer firstResult,
                                                                 Integer maxResults)
        Description copied from interface: ClientLookupProvider
        Case-insensitive search for clients that contain the given string in their public client identifier.
        Specified by:
        searchClientsByClientIdStream in interface ClientLookupProvider
        Parameters:
        realm - Realm to limit the search for clients.
        clientId - Searched substring of the public client identifier (client_id in OIDC or entityID in SAML.)
        firstResult - First result to return. Ignored if negative or null.
        maxResults - Maximum number of results to return. Ignored if negative or null.
        Returns:
        Stream of ClientModel or an empty stream if no client is found. Never returns null.
      • addClientScopes

        public void addClientScopes​(RealmModel realm,
                                    ClientModel client,
                                    Set<ClientScopeModel> clientScopes,
                                    boolean defaultScope)
        Description copied from interface: ClientProvider
        Assign clientScopes to the client. Add as default scopes (if parameter 'defaultScope' is true) or optional scopes (if parameter 'defaultScope' is false)
        Specified by:
        addClientScopes in interface ClientProvider
        Parameters:
        realm - Realm.
        client - Client.
        clientScopes - to be assigned
        defaultScope - if true the scopes are assigned as default, or optional in case of false
      • getClientScopes

        public Map<String,​ClientScopeModel> getClientScopes​(RealmModel realm,
                                                                  ClientModel client,
                                                                  boolean defaultScopes)
        Description copied from interface: ClientLookupProvider
        Return all default scopes (if defaultScope is true) or all optional scopes (if defaultScope is false) linked with the client
        Specified by:
        getClientScopes in interface ClientLookupProvider
        Parameters:
        realm - Realm
        client - Client
        defaultScopes - if true default scopes, if false optional scopes, are returned
        Returns:
        map where key is the name of the clientScope, value is particular clientScope. Returns empty map if no scopes linked (never returns null).
      • preRemove

        public void preRemove​(RealmModel realm)
      • close

        public void close()
        Specified by:
        close in interface Provider