com.mulesoft.mule.runtime.gw.policies.service

Class DefaultPolicySetDeploymentService

java.lang.Object

com.mulesoft.mule.runtime.gw.policies.service.DefaultPolicySetDeploymentService

All Implemented Interfaces:

ApiDeploymentListener, PolicySetDeploymentService

public class DefaultPolicySetDeploymentService
extends Object
implements PolicySetDeploymentService

Constructor Summary

Constructors

Constructor and Description
DefaultPolicySetDeploymentService(com.mulesoft.anypoint.retry.RunnableRetrier<com.mulesoft.mule.runtime.gw.api.key.ApiKey> policySetRetrier, MultiplexingPolicyDeploymentService policyDeploymentService, PolicyDeploymentTracker policyDeploymentTracker, PolicyStore policyStore, PolicyTemplateStore policyTemplateStore, ApiService apiService)

Method Summary

Modifier and Type	Method and Description
void	addPolicyDeploymentListener(PolicySetDeploymentListener listener) Adds a listener which will be notified of the events related to policy deployments
void	cleanUnusedTemplates() Deletes policy templates that are not being referenced in any stored PolicyDefinition
void	conciliatePolicies(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, List<PolicyDefinition> desiredPolicies) Stores missing desired policies and deletes policies that are not desired.
void	onApiDeploymentSuccess(Api api)
void	onApiRedeploymentStart(ApiImplementation implementation)
void	onApiUndeploymentStart(ApiImplementation implementation)
void	policiesForApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, PolicySet policySet) Add, updates or remove policies for the specified API.
void	removeAll(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Removes every policy from the specified API
Map<com.mulesoft.mule.runtime.gw.api.key.ApiKey,List<PolicyDefinition>>	storedOnlinePoliciesByApi() Returns the online policies present in the file system, grouped by API

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mulesoft.mule.runtime.gw.notification.ApiDeploymentListener

onApiDeploymentStart

Constructor Detail

DefaultPolicySetDeploymentService

public DefaultPolicySetDeploymentService(com.mulesoft.anypoint.retry.RunnableRetrier<com.mulesoft.mule.runtime.gw.api.key.ApiKey> policySetRetrier,
                                         MultiplexingPolicyDeploymentService policyDeploymentService,
                                         PolicyDeploymentTracker policyDeploymentTracker,
                                         PolicyStore policyStore,
                                         PolicyTemplateStore policyTemplateStore,
                                         ApiService apiService)

Method Detail

policiesForApi

public void policiesForApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                           PolicySet policySet)

Add, updates or remove policies for the specified API.

This implementation is synchronized to avoid a race condition in the case that this method is called a second time for the same API when the processing of the first one has not finished. This is a real possibility since the callers are not synchronized

Specified by:

policiesForApi in interface PolicySetDeploymentService

Parameters:

apiKey - specified API

policySet - set of policies

removeAll

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

Description copied from interface: PolicySetDeploymentService

Removes every policy from the specified API

Specified by:

removeAll in interface PolicySetDeploymentService

Parameters:

apiKey - specified API

onApiDeploymentSuccess

public void onApiDeploymentSuccess(Api api)

Specified by:

onApiDeploymentSuccess in interface ApiDeploymentListener

onApiUndeploymentStart

public void onApiUndeploymentStart(ApiImplementation implementation)

Specified by:

onApiUndeploymentStart in interface ApiDeploymentListener

onApiRedeploymentStart

public void onApiRedeploymentStart(ApiImplementation implementation)

Specified by:

onApiRedeploymentStart in interface ApiDeploymentListener

addPolicyDeploymentListener

public void addPolicyDeploymentListener(PolicySetDeploymentListener listener)

Description copied from interface: PolicySetDeploymentService

Adds a listener which will be notified of the events related to policy deployments

Specified by:

addPolicyDeploymentListener in interface PolicySetDeploymentService

Parameters:

listener - the listener to add

conciliatePolicies

public void conciliatePolicies(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                               List<PolicyDefinition> desiredPolicies)

Description copied from interface: PolicySetDeploymentService

Stores missing desired policies and deletes policies that are not desired. This is necessary when policies are replicated and the API is not deployed in a node, but it is still wanted to reflect the policies state in that node

Specified by:

conciliatePolicies in interface PolicySetDeploymentService

Parameters:

apiKey - api to conciliate

desiredPolicies - list of desired policies

cleanUnusedTemplates

public void cleanUnusedTemplates()

Description copied from interface: PolicySetDeploymentService

Deletes policy templates that are not being referenced in any stored PolicyDefinition

Specified by:

cleanUnusedTemplates in interface PolicySetDeploymentService

storedOnlinePoliciesByApi

public Map<com.mulesoft.mule.runtime.gw.api.key.ApiKey,List<PolicyDefinition>> storedOnlinePoliciesByApi()

Description copied from interface: PolicySetDeploymentService

Returns the online policies present in the file system, grouped by API

Specified by:

storedOnlinePoliciesByApi in interface PolicySetDeploymentService

Returns:

a map with an entry for every API that has policies stored