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

Interface PolicySetDeploymentService

All Superinterfaces:

ApiDeploymentListener

All Known Implementing Classes:

DefaultPolicySetDeploymentService

public interface PolicySetDeploymentService
extends ApiDeploymentListener

Provides functionality to update set of policies, all of them related to the same Api. Also, notifies the updates to all PolicySetDeploymentListener that are listening.

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	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	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 interface com.mulesoft.mule.runtime.gw.notification.ApiDeploymentListener

onApiDeploymentStart, onApiDeploymentSuccess, onApiRedeploymentStart, onApiUndeploymentStart

Method Detail

policiesForApi

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

Add, updates or remove policies for the specified API.

Parameters:

apiKey - specified API

policySet - set of policies

removeAll

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

Removes every policy from the specified API

Parameters:

apiKey - specified API

addPolicyDeploymentListener

void addPolicyDeploymentListener(PolicySetDeploymentListener listener)

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

Parameters:

listener - the listener to add

conciliatePolicies

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. 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

Parameters:

apiKey - api to conciliate

desiredPolicies - list of desired policies

storedOnlinePoliciesByApi

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

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

Returns:

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