com.atlassian.oauth2.client.api.storage.config

Interface ClientConfigStorageService

public interface ClientConfigStorageService

Method Summary

Modifier and Type	Method and Description
void	delete(String id)
Optional<ClientConfigurationEntity>	getById(String id)
ClientConfigurationEntity	getByIdOrFail(String id)
Optional<ClientConfigurationEntity>	getByName(String name)
boolean	isNameUnique(String id, String name) Returns whether given name is unique.
List<ClientConfigurationEntity>	list()
ClientConfigurationEntity	save(ClientConfigurationEntity clientConfigurationEntity) Creates or updates the ClientConfigurationEntity

Method Detail

save

@Nonnull
ClientConfigurationEntity save(@Nonnull
                                        ClientConfigurationEntity clientConfigurationEntity)
                                 throws ConfigurationNotFoundException

Creates or updates the ClientConfigurationEntity

Parameters:

clientConfigurationEntity - the entity to create

Returns:

The saved entity, with the ID if created

Throws:

ConfigurationNotFoundException - if the configuration for the given id wasn't found

delete

void delete(@Nonnull
            String id)
     throws ConfigurationNotFoundException

Parameters:

id - of ClientConfigurationEntity to delete

Throws:

ConfigurationNotFoundException - if the configuration for the given id wasn't found

getById

@Nonnull
Optional<ClientConfigurationEntity> getById(@Nonnull
                                                     String id)

Parameters:

id - of the ClientConfigurationEntity from the store

Returns:

The Optional ClientConfigurationEntity from the store for the id, or Optional.empty()

getByIdOrFail

@Nonnull
ClientConfigurationEntity getByIdOrFail(@Nonnull
                                                 String id)
                                          throws ConfigurationNotFoundException

Parameters:

id - of the ClientConfigurationEntity from the store

Returns:

The Optional ClientConfigurationEntity from the store for the id

Throws:

ConfigurationNotFoundException - if the configuration for the given id wasn't found

getByName

@Nonnull
Optional<ClientConfigurationEntity> getByName(@Nonnull
                                                       String name)

Parameters:

name - of the ClientConfigurationEntity from the store

Returns:

The Optional ClientConfigurationEntity from the store for the name, or Optional.empty()

list

@Nonnull
List<ClientConfigurationEntity> list()

Returns:

All the saved ClientConfigurationEntity ordered by name ascending, or an empty list

isNameUnique

boolean isNameUnique(@Nullable
                     String id,
                     @Nonnull
                     String name)

Returns whether given name is unique.

Parameters:

id - id of the persisted configuration or null, if it's a new one

name - name to be checked for uniqueness

Returns:

whether given name is unique