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

Interface PolicyDeploymentTracker

All Known Implementing Classes:

DefaultPolicyDeploymentTracker

public interface PolicyDeploymentTracker

Keeps track of the deployment status of the policies

Method Summary

Modifier and Type	Method and Description
void	addPolicyDeploymentListener(PolicyDeploymentListener listener)
List<PolicyDefinition>	apiRemoved(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Removes every deployment status of the specified api
Optional<PolicyDefinition>	findById(String policyId) Looks for a policy through the existing deployments
List<PolicyDeploymentStatus>	onlinePolicyStatuses(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Returns the statuses of the online policies that are being tracked
void	policyDeployed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, PolicyDeploymentStatus policyDeploymentStatus) Updates the deployment status of the specified policy
boolean	policyHasDeployments(String policyId) Whether a policy has existing deployments or not
void	policyRemoved(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, String policyId) Removes the deployment status of the specified policy
Optional<PolicyDeploymentStatus>	policyStatus(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, String policyId) Gets the deployment status of the specified policy
List<PolicyDeploymentStatus>	policyStatuses(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Returns the statuses of the policies that are being tracked

Method Detail

addPolicyDeploymentListener

void addPolicyDeploymentListener(PolicyDeploymentListener listener)

apiRemoved

List<PolicyDefinition> apiRemoved(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Removes every deployment status of the specified api

Parameters:

apiKey - api

Returns:

the list of policies for that api or empty if there are none

policyRemoved

void policyRemoved(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                   String policyId)

Removes the deployment status of the specified policy

Parameters:

apiKey - the api owner of the policy

policyId - id of the policy that was removed

policyDeployed

void policyDeployed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                    PolicyDeploymentStatus policyDeploymentStatus)

Updates the deployment status of the specified policy

Parameters:

apiKey - the api owner of the policy

policyDeploymentStatus - the deployment status

policyStatus

Optional<PolicyDeploymentStatus> policyStatus(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                                              String policyId)

Gets the deployment status of the specified policy

Parameters:

apiKey - the api owner of the policy

policyId - the id of the policy

onlinePolicyStatuses

List<PolicyDeploymentStatus> onlinePolicyStatuses(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Returns the statuses of the online policies that are being tracked

Parameters:

apiKey - the api of the policies to return

Returns:

the list of online policy statuses or empty if there are none

policyStatuses

List<PolicyDeploymentStatus> policyStatuses(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Returns the statuses of the policies that are being tracked

Parameters:

apiKey - the api of the policies to return

Returns:

the list of policy statuses or empty if there are none

findById

Optional<PolicyDefinition> findById(String policyId)

Looks for a policy through the existing deployments

Parameters:

policyId - id of the policy to look for

Returns:

the policy definition or empty if non found

policyHasDeployments

boolean policyHasDeployments(String policyId)

Whether a policy has existing deployments or not

Parameters:

policyId - the policy id

Returns:

true if there are deployments, false otherwise