Package org.epics.archiverappliance.mgmt.policy

Class ExecutePolicy

java.lang.Object

org.epics.archiverappliance.mgmt.policy.ExecutePolicy

All Implemented Interfaces:

AutoCloseable

public class ExecutePolicy
extends Object
implements AutoCloseable

Given the information computed by the engine about the PV, compute the archiving policy using policies.py Information to the policies.py is passed in as a dictionary with these keys

1. dbrtype -- The ArchDBRType of the PV
2. eventRate -- The sampled event rate in events per second.
3. eventCount -- The total number of events.
4. storageRate -- The sampled storage in bytes per seconds.
5. aliasName -- The value of the .NAME field for aliases
6. policyName -- If the user has overridden the policy when requesting archiving, this is the name of the policy

All the extra fields are use the fieldName as the key (for example, ADEL comes in as .ADEL). The result of policy execution is a another dictionary with these keys

1. samplingPeriod -- The sampling period to use for this PV.
2. samplingMethod -- The sampling method to use for this PV.
3. policyName -- The name of the policy that was used for this PV.
4. controlPV -- Another PV that can be used to conditionally archive this PV.
5. dataStores -- An array of StoragePlugin URL's that can be parsed by StoragePluginURLParser. These form the stages of data storage for this PV.
6. archiveFields -- A optional array of fields that will be archived as part of archiving the .VAL field for this PV.
7. appliance -- Optional; assign this PV to this appliance. This is a string and is the identity of the appliance you want to assign this PV to.

Author:

mshankar

Constructor Summary

Constructors

Constructor	Description
ExecutePolicy(ConfigService configService)

Method Summary

Modifier and Type	Method	Description
void	close()
PolicyConfig	computePolicyForPV(String pvName, HashMap<String,Object> pvInfo)	Compute the policy for a PV
List<String>	getFieldsArchivedAsPartOfStream()
HashMap<String,String>	getPolicyList()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutePolicy

public ExecutePolicy(ConfigService configService)
              throws IOException

Throws:

IOException

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

computePolicyForPV

public PolicyConfig computePolicyForPV(String pvName,
                                       HashMap<String,Object> pvInfo)
                                throws IOException

Compute the policy for a PV

Parameters:

pvName - The name of PV.

pvInfo - HashMap

Returns:

PolicyConfig  

Throws:

IOException -  

getPolicyList

public HashMap<String,String> getPolicyList()
                                           throws IOException

Throws:

IOException

getFieldsArchivedAsPartOfStream

public List<String> getFieldsArchivedAsPartOfStream()
                                             throws IOException

Throws:

IOException