com.mulesoft.modules.oauth2.provider.api.client

Interface ClientStore

All Superinterfaces:

ClientRegistration

All Known Implementing Classes:

ObjectStoreClientStore

public interface ClientStore
extends ClientRegistration

A store that loads the information of a oauth 2.0 client.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
Client	getClientById(String clientId) Returns a client based on the provided client Id.
default Client	getClientById(String clientId, String clientSecret) Returns a client based on the provided client Id.

Methods inherited from interface com.mulesoft.modules.oauth2.provider.internal.client.ClientRegistration

addClient, removeClient, removeClient

Method Detail

getClientById

Client getClientById(String clientId)
              throws NoSuchClientException

Returns a client based on the provided client Id. If client Id is not valid then this method will throw an exception.

Parameters:

clientId - The clientId

Returns:

The client.

Throws:

NoSuchClientException

OAuth2Exception

getClientById

default Client getClientById(String clientId,
                             String clientSecret)
                      throws NoSuchClientException

Returns a client based on the provided client Id. If client Id is not valid then this method will throw an exception. Additionally the client secret is provided in case it is needed to retrieve said client. There is NO guarantee that the returned client matches with the provided secret.

Parameters:

clientId - The clientId

clientSecret - The clientSecret

Returns:

The client.

Throws:

NoSuchClientException

OAuth2Exception