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

Class GateKeeper

java.lang.Object

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

All Implemented Interfaces:

ApiContractsListener, ApiDeploymentListener, PolicySetDeploymentListener

Direct Known Subclasses:

BlockingGateKeeper, HdpApisHealthCheckListener

public abstract class GateKeeper
extends Object
implements PolicySetDeploymentListener, ApiContractsListener, ApiDeploymentListener

Monitors an api until policies and contracts are successfully applied then proceeds to unlock it.

Field Summary

Fields

Modifier and Type	Field and Description
protected ApiService	apiService

Constructor Summary

Constructors

Constructor and Description
GateKeeper(ApiService apiService)

Method Summary

Modifier and Type	Method and Description
protected abstract void	blockApi(Api api)
protected boolean	everyPolicySuccessfullyApplied(List<PolicyDefinition> policyDefinitions, List<PolicyDefinitionDeploymentStatus> deploymentStatuses)
protected Optional<Api>	getBlockedMonitoredApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)
protected Optional<Api>	getMonitoredApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)
protected abstract boolean	isMonitored(Api api)
void	onApiDeploymentStart(Api api) Block API before listener is started
void	onContractsLoaded(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Updates the gatekeeper status to indicate that contracts where correctly loaded.
void	onContractsRequired(Api api)
void	onNoContractsRequired(Api api)
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 abstract void	unblockApi(Api api)
protected abstract boolean	validOrigin(PolicySet set)

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.policies.lifecyle.PolicySetDeploymentListener

onPoliciesRemoved

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

onApiDeploymentSuccess, onApiRedeploymentStart, onApiUndeploymentStart

Field Detail

apiService

protected final ApiService apiService

Constructor Detail

GateKeeper

public GateKeeper(ApiService apiService)

Method Detail

onPolicySetDeploymentCompleted

public 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

Specified by:

onPolicySetDeploymentCompleted in interface PolicySetDeploymentListener

Parameters:

apiKey - key of the API

policySet - set of policies that were deployed

deploymentStatuses - statuses of policies that were deployed

onContractsLoaded

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

Updates the gatekeeper status to indicate that contracts where correctly loaded.

Specified by:

onContractsLoaded in interface ApiContractsListener

onContractsRequired

public void onContractsRequired(Api api)

Specified by:

onContractsRequired in interface ApiContractsListener

onNoContractsRequired

public void onNoContractsRequired(Api api)

Specified by:

onNoContractsRequired in interface ApiContractsListener

getMonitoredApi

protected Optional<Api> getMonitoredApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Parameters:

apiKey - the key of the API to retrieve.

Returns:

the API corresponding to the apiKey if fulfills the requirements for the Gatekeeper to observe it, or Optional.empty() otherwise.

getBlockedMonitoredApi

protected Optional<Api> getBlockedMonitoredApi(com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Parameters:

apiKey - the key of the API to retrieve.

Returns:

@return the API corresponding to the apiKey if it fulfills the requirements for the Gatekeeper to observe it has not yet been unblocked.

everyPolicySuccessfullyApplied

protected boolean everyPolicySuccessfullyApplied(List<PolicyDefinition> policyDefinitions,
                                                 List<PolicyDefinitionDeploymentStatus> deploymentStatuses)

validOrigin

protected abstract boolean validOrigin(PolicySet set)

Parameters:

set - PolicySet who's origin needs to be checked.

Returns:

true if the origin of the policy set is valid for the gatekeeper configuration.

isMonitored

protected abstract boolean isMonitored(Api api)

blockApi

protected abstract void blockApi(Api api)

unblockApi

protected abstract void unblockApi(Api api)

onApiDeploymentStart

public void onApiDeploymentStart(Api api)

Block API before listener is started

Specified by:

onApiDeploymentStart in interface ApiDeploymentListener

Parameters:

api - API implementation that it's deployment started