public interface AnalyzerExternalAccess
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANALYZER_EXTERNAL_ACCESS
The Constant ANALYZER_EXTERNAL_ACCESS.
|
Modifier and Type | Method and Description |
---|---|
void |
closeEventIterator(java.io.Serializable iteratorKey)
Discards the iterator associated to the given key, possibly releasing
resources.
|
long |
countEvents(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel,
EventFilter filter)
Counts the number of available events matching a given filter.
|
java.util.Properties |
getBladeProperties(java.lang.String testName,
java.lang.String bladeId)
Gets the java system properties for the given blade from the given test
run.
|
java.lang.String[] |
getEventFieldLabels(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel)
Gets the labels of fields hold by a given event type.
|
java.io.Serializable |
getEventIterator(java.lang.String testName,
java.lang.String bladeId,
java.lang.String eventTypeLabel,
EventFilter filter)
Creates an event iterator.
|
BladeEvent[] |
getNextEvents(java.io.Serializable iteratorKey,
int count)
Gets next events from the given event iterator.
|
BladeDescriptor[] |
getTestPlan(java.lang.String testName,
BladeFilter filter)
Gets the test plan definition for a given test run name.
|
TestDescriptor[] |
getTests(TestFilter filter)
Gets a list of test runs matching a given filter.
|
static final java.lang.String ANALYZER_EXTERNAL_ACCESS
TestDescriptor[] getTests(TestFilter filter) throws ClifException
filter
- the test run filter. If null, all available test runs are
returned.ClifException
- the clif exceptionjava.util.Properties getBladeProperties(java.lang.String testName, java.lang.String bladeId) throws ClifException
testName
- the test run namebladeId
- the blade identifierClifException
- the clif exceptionBladeDescriptor[] getTestPlan(java.lang.String testName, BladeFilter filter) throws ClifException
filter
- retains only blades (injectors, probes) accepted by this
filter. If null, all blades are retained.testName
- the test run nameClifException
- the clif exceptionjava.lang.String[] getEventFieldLabels(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel)
testName
- the test run namebladeId
- the blade identifier from the given test runeventTypeLabel
- the label of the event typejava.io.Serializable getEventIterator(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
testName
- the test name to retrieve events frombladeId
- the blade identifier in this test to retrieve events fromeventTypeLabel
- the type label of the retrieved eventsfilter
- the filter object to be used for event selection. If null,
the iterator will return all events. The filter object may
throw a NoMoreEvent exception, in which case current iterator
step stops and currently selected events are returned.ClifException
- the given test, blade, or event type could not be
foundgetNextEvents(Serializable, int)
,
closeEventIterator(Serializable)
BladeEvent[] getNextEvents(java.io.Serializable iteratorKey, int count) throws ClifException
iteratorKey
- the key for the target event iteratorcount
- the number of event to get (at most)ClifException
- the clif exceptiongetEventIterator(String, String, String, EventFilter)
,
closeEventIterator(Serializable)
void closeEventIterator(java.io.Serializable iteratorKey)
iteratorKey
- the key for the target event iteratorlong countEvents(java.lang.String testName, java.lang.String bladeId, java.lang.String eventTypeLabel, EventFilter filter) throws ClifException
testName
- the test name to retrieve events frombladeId
- the blade identifier in this test to retrieve events fromeventTypeLabel
- the type label of the retrieved eventsfilter
- the filter object to be used for event selection. If null,
all events are counted. Counting stops before completion if
the filter object throws a NoMoreEvent exception, in which
case count value before exception is returned.ClifException
- the clif exception