com.mulesoft.mule.runtime.gw.api.client

Interface ClientsRepository

public interface ClientsRepository

Repository providing Clients defined in API Platform.

Method Summary

Modifier and Type	Method and Description
CoreServicesClient	getBy(String id) Retrieves Clients defined in API Platform by an id.
CoreServicesClient	getBy(String id, String secret) Retrieves Clients defined in API Platform by id and secret.

Method Detail

getBy

CoreServicesClient getBy(String id)
                  throws ClientsRepositoryException

Retrieves Clients defined in API Platform by an id. Each implementation may choose to implement an optimization algorithm to avoid subsequent calls or fallback mechanisms for when Platform is down.

Parameters:

id - a String.

Returns:

the matching Client or raise an error if it could not be found.

Throws:

ClientsRepositoryException - whenever the Client is not found or a connectivity error arises.

getBy

CoreServicesClient getBy(String id,
                         String secret)
                  throws ClientsRepositoryException

Retrieves Clients defined in API Platform by id and secret. Each implementation may choose to implement an optimization algorithm to avoid subsequent calls or fallback mechanisms for when Platform is down.

Parameters:

id - a String.

secret - a String.

Returns:

the matching Client or raise an error if it could not be found.

Throws:

ClientsRepositoryException - whenever the Client is not found or a connectivity error arises.