Package com.atlassian.bitbucket.jenkins.internal.applink.oauth.serviceprovider.consumer

Interface ServiceProviderConsumerStore

All Known Implementing Classes:

PersistentServiceProviderConsumerStore

public interface ServiceProviderConsumerStore

Provides persistent storage for OAuth consumers. The implementation of this store should only concern itself with the immediate task that it is being asked to perform.

Method Summary

Modifier and Type	Method	Description
void	add(Consumer consumer)	Add the consumer to the store.
void	delete(String key)	Deletes a consumer whose key is equal to the given key
Optional<Consumer>	get(String key)	Retrieve a consumer from the store whose key attribute is equal to the key parameter, or empty if such a consumer doesn't exist
Iterable<Consumer>	getAll()	Retrieve all the consumers from the store.
void	update(Consumer consumer)	Updates an existing consumer.

Method Details

add

void add(Consumer consumer)

Add the consumer to the store.

Parameters:

consumer - the consumer to be added, cannot be null

Throws:

StoreException - if a consumer with the same key already exists

NullPointerException - if the given consumer is null

get

Optional<Consumer> get(String key)

Retrieve a consumer from the store whose key attribute is equal to the key parameter, or empty if such a consumer doesn't exist

Parameters:

key - the consumer key

Returns:

Consumer whose key is equal to the given key, or empty if such a consumer doesn't exist

Throws:

NullPointerException - if the given key is null

getAll

Iterable<Consumer> getAll()

Retrieve all the consumers from the store.

Returns:

all the consumers from the store

Throws:

StoreException - if there is a problem retrieving one or more of the consumers

delete

void delete(String key)

Deletes a consumer whose key is equal to the given key

Parameters:

key - the key of the consumer to be deleted

Throws:

NullPointerException - if the given key is null

update

void update(Consumer consumer)

Updates an existing consumer.

Parameters:

consumer - the consumer to update

Throws:

StoreException - if a consumer with the key does not exists