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

Interface TransactionalPolicyDeploymentService

All Known Implementing Classes:

DefaultTransactionalPolicyDeploymentService, InternalPolicyDeploymentService

public interface TransactionalPolicyDeploymentService

Provides the functionality to transactionally modify policy deployments. It contains fallback mechanisms to avoid apis remaining unprotected.

Method Summary

Modifier and Type	Method and Description
void	deploy(PolicyDefinition policy, Api api) Deploys the policy to the specified API implementation.
void	revertPolicy(PolicyDefinition policy, Api api) Indicates that the version currently applied has become the official configuration.
void	undeploy(PolicyDefinition policy, Api api) Undeploys the given policy from the specified API implementation.
void	update(PolicyDefinition oldPolicy, PolicyDefinition updatedPolicy, Api api) Tries to update the configuration of the policy.
void	updateOrder(PolicyDefinition oldPolicy, PolicyDefinition updatedPolicy, Api api) Tries to update the order of the policy.

Method Detail

deploy

void deploy(PolicyDefinition policy,
            Api api)

Deploys the policy to the specified API implementation.

Parameters:

policy - policy to deploy

api - where to deploy

updateOrder

void updateOrder(PolicyDefinition oldPolicy,
                 PolicyDefinition updatedPolicy,
                 Api api)

Tries to update the order of the policy. If the order update fails a regular update will be triggered

Parameters:

oldPolicy - the policyDefinition before the order change

updatedPolicy - the policyDefinition after the order change

api - the api to which the policy will be deployed

update

void update(PolicyDefinition oldPolicy,
            PolicyDefinition updatedPolicy,
            Api api)

Tries to update the configuration of the policy. If the update fails the previous status of the policy will be recovered.

Parameters:

oldPolicy - the policyDefinition before the configuration change

updatedPolicy - the policyDefinition after the configuration change

api - the api to which the policy will be deployed

revertPolicy

void revertPolicy(PolicyDefinition policy,
                  Api api)

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.

api - the api to which the policy will be deployed

undeploy

void undeploy(PolicyDefinition policy,
              Api api)

Undeploys the given policy from the specified API implementation.

Parameters:

policy - the policy to undeploy

api - from where to undeploy