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

Class PvaGetAllPVs

java.lang.Object

org.epics.archiverappliance.mgmt.pva.actions.PvaGetAllPVs

All Implemented Interfaces:

PvaAction

public class PvaGetAllPVs
extends Object
implements PvaAction

Get all the PVs in the cluster. Note this call can return millions of PVs

Additional parameters which can be packaged as uri query parameters pv - An optional argument that can contain a GLOB wildcard. We will return PVs that match this GLOB. For example, if pv=KLYS*, the server will return all PVs that start with the string KLYS. If both pv and regex are unspecified, we match against all PVs.

regex - An optional argument that can contain a Java regex wildcard. We will return PVs that match this regex. For example, if pv=KLYS*, the server will return all PVs that start with the string KLYS.

limit - An optional argument that specifies the number of matched PV's that are retured. If unspecified, we return 500 PV names. To get all the PV names, (potentially in the millions), set limit to –1.

example

request: epics:nt/NTURI:1.0

• string scheme pva
• string path getAllPVs

response epics:nt/NTScalarArray:1.0

• string[] value ["pv1", "pv2", ....]

Based on GetAllPVs

Author:

Kunal Shroff, mshankar

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
PvaGetAllPVs()

Method Summary

Modifier and Type	Method	Description
String	getName()	Name of the action
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

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

PvaGetAllPVs

public PvaGetAllPVs()

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.