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

Class DefaultPolicyStore

java.lang.Object

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

All Implemented Interfaces:

PolicyStore

public class DefaultPolicyStore
extends Object
implements PolicyStore

Default implementation that stores the policies in the file system

Field Summary

Fields

Modifier and Type	Field and Description
static String	POLICY_CONFIG_XML_FILE_NAME
static String	POLICY_DEFINITION_JSON_FILE_NAME

Constructor Summary

Constructors

Constructor and Description
DefaultPolicyStore(EncryptedPropertiesSerializer encryptedPropertiesSerializer)

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

Methods inherited from class java.lang.Object

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

Field Detail

POLICY_DEFINITION_JSON_FILE_NAME

public static final String POLICY_DEFINITION_JSON_FILE_NAME

See Also:

Constant Field Values

POLICY_CONFIG_XML_FILE_NAME

public static final String POLICY_CONFIG_XML_FILE_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultPolicyStore

public DefaultPolicyStore(EncryptedPropertiesSerializer encryptedPropertiesSerializer)

Method Detail

load

public List<PolicyDefinition> load()

Description copied from interface: PolicyStore

Returns every stored Policy definition

Specified by:

load in interface PolicyStore

Returns:

Collection containing every stored policy definition

onlinePolicies

public List<PolicyDefinition> onlinePolicies()

Description copied from interface: PolicyStore

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

Specified by:

onlinePolicies in interface PolicyStore

Returns:

map of the present policies

offlinePolicies

public List<PolicyDefinition> offlinePolicies()

Description copied from interface: PolicyStore

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

Specified by:

offlinePolicies in interface PolicyStore

Returns:

map of the present policies

contains

public boolean contains(String policyName)

Description copied from interface: PolicyStore

Checks whether the specified policy is present in the store

Specified by:

contains in interface PolicyStore

Parameters:

policyName - name of the policy to check

Returns:

true or false whether the specified policy is present or not

getPolicyConfigFile

public File getPolicyConfigFile(String policyName)

Description copied from interface: PolicyStore

Returns the physical config file of the specified policy

Specified by:

getPolicyConfigFile in interface PolicyStore

Parameters:

policyName - name of the policy

Returns:

the config file

getEncryptedPropertiesFile

public File getEncryptedPropertiesFile(String policyName)

Description copied from interface: PolicyStore

Returns the properties file of the specified policy

Specified by:

getEncryptedPropertiesFile in interface PolicyStore

Parameters:

policyName - name of the policy

Returns:

the properties file

remove

public boolean remove(String policyName)

Description copied from interface: PolicyStore

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

Specified by:

remove in interface PolicyStore

Parameters:

policyName - name of the policy to remove

Returns:

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

store

public void store(PolicyDefinition policyDefinition)

Description copied from interface: PolicyStore

Stores just the policy definition.

Specified by:

store in interface PolicyStore

Parameters:

policyDefinition - policy definition to store

store

public void store(Policy policy)

Description copied from interface: PolicyStore

Stores the complete policy.

Specified by:

store in interface PolicyStore

Parameters:

policy - policy to store

storeDeploymentFailure

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

Description copied from interface: PolicyStore

Stores the deployment failure exception in the failed policies folder

Specified by:

storeDeploymentFailure in interface PolicyStore

Parameters:

policyDefinition - the policy that failed

apiKey - the API where the policy deployment was being deployed

exception - the failure

cleanDeploymentFailure

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

Description copied from interface: PolicyStore

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

Specified by:

cleanDeploymentFailure in interface PolicyStore

Parameters:

policyDefinition - the policy that failed

apiKey - the API where the policy deployment was being deployed

cleanDeploymentFailures

public void cleanDeploymentFailures(String policyName)

Description copied from interface: PolicyStore

Deletes every stored deployment failure log of a policy

Specified by:

cleanDeploymentFailures in interface PolicyStore

Parameters:

policyName - name of the policy