com.mulesoft.mule.runtime.gw.policies.store

Interface PolicyStore

All Known Implementing Classes:

DefaultPolicyStore

public interface PolicyStore

Method Summary

Modifier and Type	Method and Description
void	cleanDeploymentFailure(PolicyDefinition policyDefinition, com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey) Deletes the stored deployment failure log of a policy to a specific API
void	cleanDeploymentFailures(String policyName) Deletes every stored deployment failure log of a policy
boolean	contains(String policyName) Checks whether the specified policy is present in the store
File	getEncryptedPropertiesFile(String policyName) Returns the properties file of the specified policy
File	getPolicyConfigFile(String policyName) Returns the physical config file of the specified policy
List<PolicyDefinition>	load() Returns every stored Policy definition
List<PolicyDefinition>	offlinePolicies() Reads and returns every offline policy that is present in the store
List<PolicyDefinition>	onlinePolicies() Reads and returns every online policy that is present in the store
boolean	remove(String policyName) Removes the specified policy, valid or failed, from the store.
void	store(Policy policy) Stores the complete policy.
void	store(PolicyDefinition policyDefinition) Stores just the policy definition.
void	storeDeploymentFailure(PolicyDefinition policyDefinition, com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey, Exception exception) Stores the deployment failure exception in the failed policies folder

Method Detail

load

List<PolicyDefinition> load()

Returns every stored Policy definition

Returns:

Collection containing every stored policy definition

store

void store(PolicyDefinition policyDefinition)

Stores just the policy definition.

Parameters:

policyDefinition - policy definition to store

store

void store(Policy policy)

Stores the complete policy.

Parameters:

policy - policy to store

remove

boolean remove(String policyName)

Removes the specified policy, valid or failed, from the store.

Parameters:

policyName - name of the policy to remove

Returns:

true or false whether it was able to remove it or not

onlinePolicies

List<PolicyDefinition> onlinePolicies()

Reads and returns every online policy that is present in the store

Returns:

map of the present policies

offlinePolicies

List<PolicyDefinition> offlinePolicies()

Reads and returns every offline policy that is present in the store

Returns:

map of the present policies

contains

boolean contains(String policyName)

Checks whether the specified policy is present in the store

Parameters:

policyName - name of the policy to check

Returns:

true or false whether the specified policy is present or not

getPolicyConfigFile

File getPolicyConfigFile(String policyName)

Returns the physical config file of the specified policy

Parameters:

policyName - name of the policy

Returns:

the config file

getEncryptedPropertiesFile

File getEncryptedPropertiesFile(String policyName)

Returns the properties file of the specified policy

Parameters:

policyName - name of the policy

Returns:

the properties file

storeDeploymentFailure

void storeDeploymentFailure(PolicyDefinition policyDefinition,
                            com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey,
                            Exception exception)

Stores the deployment failure exception in the failed policies folder

Parameters:

policyDefinition - the policy that failed

apiKey - the API where the policy deployment was being deployed

exception - the failure

cleanDeploymentFailure

void cleanDeploymentFailure(PolicyDefinition policyDefinition,
                            com.mulesoft.mule.runtime.gw.api.key.ApiKey apiKey)

Deletes the stored deployment failure log of a policy to a specific API

Parameters:

policyDefinition - the policy that failed

apiKey - the API where the policy deployment was being deployed

cleanDeploymentFailures

void cleanDeploymentFailures(String policyName)

Deletes every stored deployment failure log of a policy

Parameters:

policyName - name of the policy