com.mulesoft.mule.runtime.gw.policies.lifecyle

Class BlockingGateKeeper

java.lang.Object

com.mulesoft.mule.runtime.gw.policies.lifecyle.GateKeeper

com.mulesoft.mule.runtime.gw.policies.lifecyle.BlockingGateKeeper

All Implemented Interfaces:

ApiContractsListener, ApiDeploymentListener, PolicySetDeploymentListener

Direct Known Subclasses:

FlexibleGateKeeper, StrictGateKeeper

public abstract class BlockingGateKeeper
extends GateKeeper

GateKeeper can operate in three different modes: - STRICT (default): blocks the API till the first policy reconciliation cycle. If the request succeeds and all te policies are applied OK, then the API is unblocked. Otherwise the API remains blocked till a successful reconciliation cycle. - FLEXIBLE: blocks the API till the first policy reconciliation cycle. If the request succeeds and all the policies are applied OK, then the API is unblocked. If the request fails with one of the outages status codes and a cached version exists, then the policies from the cached request are applied and if successful the API is unblocked. Otherwise the API remains blocked till a successful reconciliation cycle. - DISABLED: the API is never blocked, so it can be accessed even before any policy is applied.

Once an app tracked flows are enabled they remain so even if a future policy application fails.

GateKeeper logic:

at gateway startup - remove local online policies from filesystem

at app deploy - stop app tracked flows on deploy

at API policies request time - cache response if successful

at policy store update (from polling or HC notification) - update required policies for particular API - check if any blocked API can be enabled

at policy application/removal - if successfully applied or removed update applied policy list - assert blocked APIs required policies and start those with nothing pending

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockingGateKeeper.GateKeeperMuleContextListener MuleContext listener used to block an API implementation before it starts its listener.

Field Summary

Fields inherited from class com.mulesoft.mule.runtime.gw.policies.lifecyle.GateKeeper

apiService

Constructor Summary

Constructors

Constructor and Description
BlockingGateKeeper(ApiService apiService, TransactionalPolicyDeploymentService policyDeployer, boolean blockFailedRevert)

Method Summary

Modifier and Type	Method and Description
protected void	blockApi(Api api)
protected void	checkRevertFailed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, List<PolicyDefinitionDeploymentStatus> deploymentStatuses)
protected void	doBlockApi(Api api)
protected boolean	hasFailedReverts(List<PolicyDefinitionDeploymentStatus> deploymentStatuses)
protected boolean	isMonitored(Api api)
void	onPoliciesRemoved(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Block API because it is being undeployed or because it is now untracked
void	onPolicySetDeploymentCompleted(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, PolicySet policySet, List<PolicyDefinitionDeploymentStatus> deploymentStatuses) Check whether the API can be unblocked after a fresh PolicySet has been applied to it
protected void	unblockApi(Api api)

Methods inherited from class com.mulesoft.mule.runtime.gw.policies.lifecyle.GateKeeper

everyPolicySuccessfullyApplied, getBlockedMonitoredApi, getMonitoredApi, onApiDeploymentStart, onContractsLoaded, onContractsRequired, onNoContractsRequired, validOrigin

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.mulesoft.mule.runtime.gw.notification.ApiDeploymentListener

onApiDeploymentSuccess, onApiRedeploymentStart, onApiUndeploymentStart

Constructor Detail

BlockingGateKeeper

public BlockingGateKeeper(ApiService apiService,
                          TransactionalPolicyDeploymentService policyDeployer,
                          boolean blockFailedRevert)

Method Detail

onPoliciesRemoved

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

Block API because it is being undeployed or because it is now untracked

Parameters:

apiKey - key of the API

isMonitored

protected boolean isMonitored(Api api)

Specified by:

isMonitored in class GateKeeper

onPolicySetDeploymentCompleted

public void onPolicySetDeploymentCompleted(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                                           PolicySet policySet,
                                           List<PolicyDefinitionDeploymentStatus> deploymentStatuses)

Description copied from class: GateKeeper

Check whether the API can be unblocked after a fresh PolicySet has been applied to it

Specified by:

onPolicySetDeploymentCompleted in interface PolicySetDeploymentListener

Overrides:

onPolicySetDeploymentCompleted in class GateKeeper

Parameters:

apiKey - key of the API

policySet - set of policies that were deployed

deploymentStatuses - statuses of policies that were deployed

checkRevertFailed

protected void checkRevertFailed(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                                 List<PolicyDefinitionDeploymentStatus> deploymentStatuses)

hasFailedReverts

protected boolean hasFailedReverts(List<PolicyDefinitionDeploymentStatus> deploymentStatuses)

blockApi

protected void blockApi(Api api)

Specified by:

blockApi in class GateKeeper

doBlockApi

protected void doBlockApi(Api api)

unblockApi

protected void unblockApi(Api api)

Specified by:

unblockApi in class GateKeeper