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

Interface PolicyDeploymentService

All Known Implementing Classes:

DefaultPolicyDeploymentService

public interface PolicyDeploymentService

Provides functionality to handle policies in a broader way than the policy engine.

Method Summary

Modifier and Type	Method and Description
void	newPolicy(PolicyDefinition policy) Deploys a policy to the API implementations specified in the definition
void	removePolicy(PolicyDefinition policyDefinition) Removes the specified policy from the API implementation specified in the definition
void	removePolicy(String policyName) Removes the specified policy
void	reorderPolicy(PolicyDefinition oldPolicy, PolicyDefinition reorderedPolicy) Changes Policy Order without reapplying the policy.
void	revertPolicy(PolicyDefinition policy) Indicates that the version currently applied has become the official configuration.
void	updatePolicy(PolicyDefinition oldPolicy, PolicyDefinition updatedPolicy) First undeploys the policy, and then deploys it again.

Method Detail

newPolicy

void newPolicy(PolicyDefinition policy)

Deploys a policy to the API implementations specified in the definition

Parameters:

policy - policy definition to handle

updatePolicy

void updatePolicy(PolicyDefinition oldPolicy,
                  PolicyDefinition updatedPolicy)

First undeploys the policy, and then deploys it again. If the new deploy fails, the old policy will try to be restored.

Parameters:

oldPolicy - policy that is currently deployed

updatedPolicy - policy with the changes that needs to be deployed

revertPolicy

void revertPolicy(PolicyDefinition policy)

Indicates that the version currently applied has become the official configuration. This is the case of a configuration being reverted once the edition failed.

Parameters:

policy - definition of the applied policy.

reorderPolicy

void reorderPolicy(PolicyDefinition oldPolicy,
                   PolicyDefinition reorderedPolicy)

Changes Policy Order without reapplying the policy. This method will try to reorder the policy without undeploying the policy; if the runtime does not support this feature, a normal update will be triggered.

Parameters:

oldPolicy - policy that is currently deployed

reorderedPolicy - policy with the new order

removePolicy

void removePolicy(PolicyDefinition policyDefinition)

Removes the specified policy from the API implementation specified in the definition

Parameters:

policyDefinition - of the policy to remove

removePolicy

void removePolicy(String policyName)

Removes the specified policy

Parameters:

policyName - of the policy to remove