com.mulesoft.mule.runtime.gw.api.service

Interface ContractService

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject, org.mule.runtime.api.service.Service, org.mule.runtime.api.artifact.SplashMessageProvider

public interface ContractService
extends org.mule.runtime.api.service.Service

Defines the ContractService, who provides the up-to-date Contracts for tracked ApiContractss.

Method Summary

Modifier and Type	Method and Description
default ContractService	contractPrefetch(ApiContractsPrefetch prefetch) The ContractService delegates the pre fetching of the ApiContractss to an ApiContractsPrefetch.
com.mulesoft.mule.runtime.gw.api.ApiContracts	contracts(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)
ContractService	contractSupplier(com.mulesoft.mule.runtime.gw.api.ApiContractsSupplier supplier) The ContractService delegates the maintaining of up-to-date ApiContractss to an ApiContractsSupplier.
ContractService	track(com.mulesoft.mule.runtime.gw.api.key.ApiKey key, String trackerDescription) Notifies the ContractService that someone needs to track an ApiContracts with matching key, therefore its contracts must be fetched.
List<com.mulesoft.mule.runtime.gw.api.key.ApiKey>	trackedApis()
ContractService	untrack(com.mulesoft.mule.runtime.gw.api.key.ApiKey key, String trackerDescription) Notifies the ContractService that someone is not tracking an ApiContracts anymore, if this Service decides to, can stop fetching Contracts for it.

Methods inherited from interface org.mule.runtime.api.service.Service

getContractName, getSplashMessage

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

contractSupplier

ContractService contractSupplier(com.mulesoft.mule.runtime.gw.api.ApiContractsSupplier supplier)

The ContractService delegates the maintaining of up-to-date ApiContractss to an ApiContractsSupplier. Every information regarding them, will be forwarded to the ApiContractsSupplier.

Parameters:

supplier - the ApiContractsSupplier.

Returns:

this.

contractPrefetch

default ContractService contractPrefetch(ApiContractsPrefetch prefetch)

The ContractService delegates the pre fetching of the ApiContractss to an ApiContractsPrefetch. Every information regarding them, will be forwarded to the ApiContractsSupplier.

Parameters:

prefetch - the ApiContractsPrefetch.

Returns:

this.

contracts

com.mulesoft.mule.runtime.gw.api.ApiContracts contracts(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)
                                                 throws UnknownAPIException

Returns:

the current ApiContracts matching the ApiKey, raises an exception when not found.

Throws:

UnknownAPIException

track

ContractService track(com.mulesoft.mule.runtime.gw.api.key.ApiKey key,
                      String trackerDescription)

Notifies the ContractService that someone needs to track an ApiContracts with matching key, therefore its contracts must be fetched. A description of the tracker is only added for detailed logging.

Parameters:

key - ApiKey.

trackerDescription - String describing the tracker.

Returns:

this.

untrack

ContractService untrack(com.mulesoft.mule.runtime.gw.api.key.ApiKey key,
                        String trackerDescription)

Notifies the ContractService that someone is not tracking an ApiContracts anymore, if this Service decides to, can stop fetching Contracts for it. Implementation should only stop fetching them when everyone has stopped tracking it.

Parameters:

key - ApiKey.

trackerDescription - String describing the tracker.

Returns:

this.

trackedApis

List<com.mulesoft.mule.runtime.gw.api.key.ApiKey> trackedApis()

Returns:

the current tracked Api's ApiKey, every Api in this list will be requiring Contracts.