com.mulesoft.mule.runtime.gw.policies.deployment

Class DefaultTransactionalPolicyDeployer

java.lang.Object

com.mulesoft.mule.runtime.gw.policies.deployment.DefaultTransactionalPolicyDeployer

All Implemented Interfaces:

PolicyDeployer, TransactionalPolicyDeployer

public class DefaultTransactionalPolicyDeployer
extends Object
implements TransactionalPolicyDeployer

Constructor Summary

Constructors

Constructor and Description
DefaultTransactionalPolicyDeployer(PolicyDeploymentTracker policyDeploymentTracker, PolicyStore policyStore, PolicyDeployer policyDeployer)

Method Summary

Modifier and Type	Method and Description
PolicyDefinitionDeploymentStatus	deploy(PolicyDefinition policyDefinition, Api api) Resolves the template, stores it an 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.
boolean	undeploy(String policyName, 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.
PolicyDefinitionDeploymentStatus	updateOrder(PolicyDefinition policy, Api api) Hot reorders the policy to the specified API implementation.
void	updateOrder(PolicyDefinition oldPolicy, PolicyDefinition updatedPolicy, Api api) Tries to update the order of the policy.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTransactionalPolicyDeployer

public DefaultTransactionalPolicyDeployer(PolicyDeploymentTracker policyDeploymentTracker,
                                          PolicyStore policyStore,
                                          PolicyDeployer policyDeployer)

Method Detail

deploy

public PolicyDefinitionDeploymentStatus deploy(PolicyDefinition policyDefinition,
                                               Api api)

Description copied from interface: PolicyDeployer

Resolves the template, stores it an deploys the policy to the specified API implementation.

Specified by:

deploy in interface PolicyDeployer

Parameters:

policyDefinition - policy to deploy

api - where to deploy

updateOrder

public PolicyDefinitionDeploymentStatus updateOrder(PolicyDefinition policy,
                                                    Api api)

Description copied from interface: PolicyDeployer

Hot reorders the policy to the specified API implementation.

Specified by:

updateOrder in interface PolicyDeployer

Parameters:

policy - policy to deploy

api - where to deploy

updateOrder

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

Description copied from interface: TransactionalPolicyDeployer

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

Specified by:

updateOrder in interface TransactionalPolicyDeployer

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

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

Description copied from interface: TransactionalPolicyDeployer

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

Specified by:

update in interface TransactionalPolicyDeployer

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

public void revertPolicy(PolicyDefinition policy,
                         Api api)

Description copied from interface: TransactionalPolicyDeployer

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

Specified by:

revertPolicy in interface TransactionalPolicyDeployer

Parameters:

policy - definition of the applied policy.

api - the api to which the policy will be deployed

undeploy

public boolean undeploy(String policyName,
                        Api api)

Description copied from interface: PolicyDeployer

Undeploys the given policy from the specified API implementation.

Specified by:

undeploy in interface PolicyDeployer

Parameters:

policyName - name of the policy to undeploy

api - from where to undeploy

Returns:

true if the policy was undeployed, false otherwise