com.mulesoft.mule.runtime.gw.deployment.tracking

Interface ApiTrackingService

All Known Implementing Classes:

DefaultApiTrackingService

public interface ApiTrackingService

Method Summary

Modifier and Type	Method and Description
void	apiTracked(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, TrackingInfo trackingInfo, PolicySet policySet, List<com.mulesoft.mule.runtime.gw.api.contract.Sla> slas) Indicates that an API was successfully tracked against API Platform
void	apiTrackingFailed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Indicates that there was an error while trying to track an API against API Platform
void	apiUntracked(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Indicates that an API does not exist in API Platform
void	clientsPolling(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, List<PlatformContractAdapter> contracts, String contractsEntityTag) Indicates that a successful polling of API's clients happened
List<Api>	getFailedTrackingApis() Returns the deployed APIs in this runtime that are not still tracked because there was a previous error while doing it.
List<Api>	getTrackedApis() Returns the deployed APIs in this runtime that were successfully tracked
List<Api>	getTrackedApisRequiringContracts() Returns the deployed APIs in this runtime that were successfully tracked and requires Contracts to be fetched

Method Detail

apiTracked

void apiTracked(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                TrackingInfo trackingInfo,
                PolicySet policySet,
                List<com.mulesoft.mule.runtime.gw.api.contract.Sla> slas)

Indicates that an API was successfully tracked against API Platform

Parameters:

apiKey - the key of the API

trackingInfo - the tracking information containing API data

policySet - the policy set present in the response of the polling process

slas - the collection of tiers present in the response of the polling process

apiUntracked

void apiUntracked(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Indicates that an API does not exist in API Platform

Parameters:

apiKey - the key of the API deployed in the runtime

apiTrackingFailed

void apiTrackingFailed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Indicates that there was an error while trying to track an API against API Platform

Parameters:

apiKey - the key of the API

getTrackedApis

List<Api> getTrackedApis()

Returns the deployed APIs in this runtime that were successfully tracked

Returns:

the list of deployed APIs or empty if there are none

getFailedTrackingApis

List<Api> getFailedTrackingApis()

Returns the deployed APIs in this runtime that are not still tracked because there was a previous error while doing it. APIs that are deployed but do not exist in API Platform are not returned.

Returns:

the list of apis

getTrackedApisRequiringContracts

List<Api> getTrackedApisRequiringContracts()

Returns the deployed APIs in this runtime that were successfully tracked and requires Contracts to be fetched

Returns:

the list of deployed APIs with Contracts or empty if there are none

clientsPolling

void clientsPolling(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                    List<PlatformContractAdapter> contracts,
                    String contractsEntityTag)

Indicates that a successful polling of API's clients happened

Parameters:

apiKey - the key of the API

contracts - the new polled contracts

contractsEntityTag, - eTag provided by the platform when retrieving API Clients. This is updated in the API TrackingInfo