com.mulesoft.mule.runtime.gw.api

Interface ApiContracts

All Superinterfaces:

org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable

public interface ApiContracts
extends org.mule.runtime.api.lifecycle.Disposable, org.mule.runtime.api.lifecycle.Initialisable

Defines an API's related Contracts. This class will remain backwards compatible.

Since:

4.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
default List<Contract>	contracts()
default boolean	contractsLoaded() Indicates if contracts for the API were successfully loaded from the Disk, Platform, etc.
default void	dispose()
default void	initialise()
Sla	sla(Client client)
Sla	sla(String clientId)
ApiContracts	updateContracts(Contract... contracts) Updates the available Contracts.
ApiContracts	updateContracts(List<Contract> contracts) Updates the available Contracts.
default ApiContracts	updateSlas(List<Sla> slas) Updates the available Slas.
Client	validate(String clientId) Validates that the Client is within a Contract for this API, otherwise throws an exception.
Client	validate(String clientId, String clientSecret) Validates that the Client is within a Contract for this Api, otherwise throws an exception.

Method Detail

updateContracts

ApiContracts updateContracts(List<Contract> contracts)

Updates the available Contracts.

Parameters:

contracts - current Contracts.

Returns:

(Subclass) this.

updateSlas

default ApiContracts updateSlas(List<Sla> slas)

Updates the available Slas.

Parameters:

slas - current Slas.

Returns:

(Subclass) this.

updateContracts

ApiContracts updateContracts(Contract... contracts)

Updates the available Contracts.

Parameters:

contracts - current Contracts.

Returns:

(Subclass) this.

sla

Sla sla(Client client)
 throws ForbiddenClientException

Returns:

the SLA of the Client, if there is no Contract for that client, an exception will be raised

Throws:

ForbiddenClientException - when the client has no SLA defined

sla

Sla sla(String clientId)
 throws ForbiddenClientException

Returns:

the SLA for a client id, if there is no Contract for that id, an exception will be raised

Throws:

ForbiddenClientException - when the client has no SLA defined

validate

Client validate(String clientId,
                String clientSecret)
         throws ForbiddenClientException

Validates that the Client is within a Contract for this Api, otherwise throws an exception.

Returns:

this

Throws:

ForbiddenClientException - when the client has no contract defined in the API

validate

Client validate(String clientId)
         throws ForbiddenClientException

Validates that the Client is within a Contract for this API, otherwise throws an exception.

Returns:

this

Throws:

ForbiddenClientException - when the client has no contract defined in the API

contracts

default List<Contract> contracts()

Returns:

every Contract related to the specified API

contractsLoaded

default boolean contractsLoaded()

Indicates if contracts for the API were successfully loaded from the Disk, Platform, etc.

initialise

default void initialise()

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

dispose

default void dispose()

Specified by:

dispose in interface org.mule.runtime.api.lifecycle.Disposable