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

Class DefaultApiTrackingService

java.lang.Object

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

All Implemented Interfaces:

ApiTrackingService

public class DefaultApiTrackingService
extends Object
implements ApiTrackingService

Constructor Summary

Constructors

Constructor and Description
DefaultApiTrackingService(ApiService apiService, PolicySetDeploymentService policySetDeploymentService, ApiConfigurationCache apiConfigurationCache, ContractSnapshots contractSnapshots, com.mulesoft.mule.runtime.gw.api.service.ContractService contractService, com.mulesoft.mule.runtime.gw.api.config.OnApiDeletedConfiguration onApiDeletedConfiguration)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultApiTrackingService

public DefaultApiTrackingService(ApiService apiService,
                                 PolicySetDeploymentService policySetDeploymentService,
                                 ApiConfigurationCache apiConfigurationCache,
                                 ContractSnapshots contractSnapshots,
                                 com.mulesoft.mule.runtime.gw.api.service.ContractService contractService,
                                 com.mulesoft.mule.runtime.gw.api.config.OnApiDeletedConfiguration onApiDeletedConfiguration)

Method Detail

apiTracked

public 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)

Description copied from interface: ApiTrackingService

Indicates that an API was successfully tracked against API Platform

Specified by:

apiTracked in interface ApiTrackingService

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

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

Description copied from interface: ApiTrackingService

Indicates that an API does not exist in API Platform

Specified by:

apiUntracked in interface ApiTrackingService

Parameters:

apiKey - the key of the API deployed in the runtime

apiTrackingFailed

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

Description copied from interface: ApiTrackingService

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

Specified by:

apiTrackingFailed in interface ApiTrackingService

Parameters:

apiKey - the key of the API

getTrackedApis

public List<Api> getTrackedApis()

Description copied from interface: ApiTrackingService

Returns the deployed APIs in this runtime that were successfully tracked

Specified by:

getTrackedApis in interface ApiTrackingService

Returns:

the list of deployed APIs or empty if there are none

getFailedTrackingApis

public List<Api> getFailedTrackingApis()

Description copied from interface: ApiTrackingService

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.

Specified by:

getFailedTrackingApis in interface ApiTrackingService

Returns:

the list of apis

getTrackedApisRequiringContracts

public List<Api> getTrackedApisRequiringContracts()

Description copied from interface: ApiTrackingService

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

Specified by:

getTrackedApisRequiringContracts in interface ApiTrackingService

Returns:

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

clientsPolling

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

Description copied from interface: ApiTrackingService

Indicates that a successful polling of API's clients happened

Specified by:

clientsPolling in interface ApiTrackingService

Parameters:

apiKey - the key of the API

contracts - the new polled contracts