org.apache.excalibur.instrument.client
Interface InstrumentManagerData

All Superinterfaces:

Data

public interface InstrumentManagerData

extends Data

Method Summary

void	createInstrumentSample(java.lang.String instrumentName, java.lang.String description, long interval, int sampleCount, long leaseTime, int sampleType) Requests that a sample be created or that its lease be updated.
void	createInstrumentSamples(java.lang.String[] instrumentNames, java.lang.String[] descriptions, long[] intervals, int[] sampleCounts, long[] leaseTimes, int[] sampleTypes) Requests that a set of samples be created or that their leases be updated.
InstrumentableData[]	getInstrumentables() Gets a thread-safe snapshot of the instrumentable list.
java.lang.String	getName() Returns the name.
boolean	updateAll() Causes the the entire instrument tree to be updated in one call.

Methods inherited from interface org.apache.excalibur.instrument.client.Data

getDescription, getStateVersion, update

Method Detail

getName

public java.lang.String getName()

Returns the name.

Returns:

The name.

getInstrumentables

public InstrumentableData[] getInstrumentables()

Gets a thread-safe snapshot of the instrumentable list.

Returns:

A thread-safe snapshot of the instrumentable list.

updateAll

public boolean updateAll()

Causes the the entire instrument tree to be updated in one call. Very fast when it is known that all or most data has changed.

Returns:

true if successful.

createInstrumentSample

public void createInstrumentSample(java.lang.String instrumentName,
                                   java.lang.String description,
                                   long interval,
                                   int sampleCount,
                                   long leaseTime,
                                   int sampleType)

Requests that a sample be created or that its lease be updated.

Parameters:

instrumentName - The full name of the instrument whose sample is to be created or updated.

description - Description to assign to the new sample.

interval - Sample interval of the new sample.

sampleCount - Number of samples in the new sample.

leaseTime - Requested lease time. The server may not grant the full lease.

sampleType - The type of sample to be created.

createInstrumentSamples

public void createInstrumentSamples(java.lang.String[] instrumentNames,
                                    java.lang.String[] descriptions,
                                    long[] intervals,
                                    int[] sampleCounts,
                                    long[] leaseTimes,
                                    int[] sampleTypes)

Requests that a set of samples be created or that their leases be updated. All array parameters must be of the same length.

Parameters:

instrumentNames - The full names of the instruments whose sample are to be created or updated.

descriptions - Descriptions to assign to the new samples.

intervals - Sample intervals of the new samples.

sampleCounts - Number of samples in each the new samples.

leaseTimes - Requested lease times. The server may not grant the full leases.

sampleTypes - The types of samples to be created.