org.daisy.pipeline.clients

Interface ClientStorage

public interface ClientStorage

Interface for creating, deleting and accessing clients

Method Summary

Modifier and Type	Method and Description
Optional<Client>	addClient(String id, String secret, Client.Role role, String contactInfo) Adds a new client to the storage using the provided details and the default priority.
Optional<Client>	addClient(String id, String secret, Client.Role role, String contactInfo, Priority priority) Adds a new client to the storage using the provided details.
Client	defaultClient() Returns the default client
boolean	delete(String id) Removes the client, the default client can't be deleted.
Optional<Client>	get(String id) Get the client idetified by the id.
List<? extends Client>	getAll() Gets all the clients in the system.
Optional<Client>	update(String id, String secret, Client.Role role, String contactInfo, Priority priority) Updates the client using the new values.

Method Detail

getAll

List<? extends Client> getAll()

Gets all the clients in the system. The default client is not listed.

Parameters:

id -

Returns:

get

Optional<Client> get(String id)

Get the client idetified by the id.

Parameters:

id -

Returns:

delete

boolean delete(String id)

Removes the client, the default client can't be deleted.

Parameters:

client -

Returns:

update

Optional<Client> update(String id,
                        String secret,
                        Client.Role role,
                        String contactInfo,
                        Priority priority)

Updates the client using the new values. Returns the updated client or absent if the client couldn't be loaded.

Parameters:

client -

Returns:

addClient

Optional<Client> addClient(String id,
                           String secret,
                           Client.Role role,
                           String contactInfo,
                           Priority priority)

Adds a new client to the storage using the provided details. Returns the created client or absent if the client couldn't be created.

Parameters:

id -

secret -

role -

contactInfo -

priority -

Returns:

addClient

Optional<Client> addClient(String id,
                           String secret,
                           Client.Role role,
                           String contactInfo)

Adds a new client to the storage using the provided details and the default priority. Returns the created client or absent if the client couldn't be created.

Parameters:

id -

secret -

role -

contactInfo -

priority -

Returns:

defaultClient

Client defaultClient()

Returns the default client

Parameters:

id -

secret -

role -

contactInfo -

priority -

Returns: