Package org.epics.archiverappliance.mgmt.pva.actions

Class PvaArchivePVAction

java.lang.Object
org.epics.archiverappliance.mgmt.pva.actions.PvaArchivePVAction
All Implemented Interfaces:
PvaAction
public class PvaArchivePVAction extends Object implements PvaAction
Add one or more pvs to the archiver.

The requests for archiving pv's, the request consists of an NTTable with a list of pv's to be archived, optional attributes include sampling period and,or samplingmethod

example: request epics:nt/NTTable:1.0

  • string[] labels [pv,samplingperiod,samplingmethod]
  • structure value
    • string[] pv [mshankar:arch:sine,mshankar:arch:cosine]
    • string[] samplingperiod [1.0,2.0]
    • string[] samplingmethod [SCAN,MONITOR]
  • string descriptor archivePVs

result epics:nt/NTTable:1.0

  • string[] labels [pvName,status]
  • structure value
    • string[] pvName [mshankar:arch:sine,mshankar:arch:cosine]
    • string[] status [Archive request submitted,Archive request submitted]

Based on ArchivePVAction

Author:
Kunal Shroff, mshankar

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.apache.logging.log4j.Logger
    logger
     
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PvaArchivePVAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Name of the action
    static org.epics.pva.data.nt.PVATable
    parseArchivePvResult(String resultString)
    example string returned { "pvName": "mshankar:arch:sine", "status": "Archive request submitted" } { "pvName": "mshankar:arch:cosine", "status": "Archive request submitted" }
    org.epics.pva.data.PVAStructure
    request(org.epics.pva.data.PVAStructure args, ConfigService configService)
    Handles an RPC request to the archiver.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • logger

      public static final org.apache.logging.log4j.Logger logger

    • NAME

      public static final String NAME
      See Also:

  • Constructor Details

    • PvaArchivePVAction

      public PvaArchivePVAction()

  • Method Details

    • getName

      public String getName()
      Description copied from interface: PvaAction
      Name of the action
      Specified by:
      getName in interface PvaAction
      Returns:
      the name of the service

    • request

      public org.epics.pva.data.PVAStructure request(org.epics.pva.data.PVAStructure args, ConfigService configService) throws PvaActionException
      Description copied from interface: PvaAction
      Handles an RPC request to the archiver.
      Specified by:
      request in interface PvaAction
      Parameters:
      args - Input arguments
      configService - Current config service
      Throws:
      PvaActionException - which is then passed to the serverPV to return the error to the user.

    • parseArchivePvResult

      public static org.epics.pva.data.nt.PVATable parseArchivePvResult(String resultString) throws ResponseConstructionException
      example string returned { "pvName": "mshankar:arch:sine", "status": "Archive request submitted" } { "pvName": "mshankar:arch:cosine", "status": "Archive request submitted" }
      Parameters:
      resultString - input string
      Returns:
      Table of queries
      Throws:
      ResponseConstructionException