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

Class ObjectStoreClientStore

java.lang.Object

com.mulesoft.modules.oauth2.provider.internal.AbstractObjectStoreBacked<Client>

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

All Implemented Interfaces:

ClientStore, ClientRegistration

public class ObjectStoreClientStore
extends AbstractObjectStoreBacked<Client>
implements ClientStore, ClientRegistration

Client store backed with an object store for saving all the clients

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENTS_PARTITION

Constructor Summary

Constructors

Constructor and Description
ObjectStoreClientStore()

Method Summary

Modifier and Type	Method and Description
void	addClient(Client client, boolean failIfPresent) Add a new client.
Client	getClientById(String clientId) Returns a client based on the provided client Id.
Client	getClientById(String clientId, String clientSecret) Returns a client based on the provided client Id.
org.mule.runtime.api.store.ObjectStore	getClientObjectStore()
void	removeClient(String clientId) Removes a registered client.
void	removeClient(String clientId, String clientSecret) Removes a registered client.
void	setKeyFormatter(KeyFormatter formatter)
void	setObjectStore(org.mule.runtime.api.store.ObjectStore clientObjectStore)

Methods inherited from class com.mulesoft.modules.oauth2.provider.internal.AbstractObjectStoreBacked

getFromObjectStore, putInObjectStore, putInObjectStore, removeFromObjectStore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENTS_PARTITION

public static final String CLIENTS_PARTITION

See Also:

Constant Field Values

Constructor Detail

ObjectStoreClientStore

public ObjectStoreClientStore()

Method Detail

getClientById

public Client getClientById(String clientId)
                     throws NoSuchClientException

Description copied from interface: ClientStore

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

Specified by:

getClientById in interface ClientStore

Parameters:

clientId - The clientId

Returns:

The client.

Throws:

NoSuchClientException

getClientById

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

Description copied from interface: ClientStore

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.

Specified by:

getClientById in interface ClientStore

Parameters:

clientId - The clientId

clientSecret - The clientSecret

Returns:

The client.

Throws:

NoSuchClientException

addClient

public void addClient(Client client,
                      boolean failIfPresent)
               throws ClientAlreadyExistsException

Description copied from interface: ClientRegistration

Add a new client. If the client already exists and the flag is set to false, it will override it with the new client.

Specified by:

addClient in interface ClientRegistration

Throws:

ClientAlreadyExistsException - if failIfPresent is set to true and a client with the same clientId is in the store

removeClient

public void removeClient(String clientId)

Description copied from interface: ClientRegistration

Removes a registered client.

Specified by:

removeClient in interface ClientRegistration

Parameters:

clientId - The client Id.

removeClient

public void removeClient(String clientId,
                         String clientSecret)
                  throws NoSuchClientException

Description copied from interface: ClientRegistration

Removes a registered client.

Specified by:

removeClient in interface ClientRegistration

Parameters:

clientId - The client Id.

clientSecret - The client secret.

Throws:

NoSuchClientException - If client does not exist a NoSuchClientException is thrown.

setObjectStore

public void setObjectStore(org.mule.runtime.api.store.ObjectStore clientObjectStore)

setKeyFormatter

public void setKeyFormatter(KeyFormatter formatter)

getClientObjectStore

public org.mule.runtime.api.store.ObjectStore getClientObjectStore()