org.apache.excalibur.instrument.client
Interface InstrumentData

All Superinterfaces:

Data, ElementData

public interface InstrumentData

extends ElementData

Field Summary

static int	INSTRUMENT_TYPE_COUNTER Type which identifies CounterInstruments.
static int	INSTRUMENT_TYPE_NONE Type which specifies that the type of a Instrument has not yet been determined.
static int	INSTRUMENT_TYPE_VALUE Type which identifies ValueInstruments.

Method Summary

boolean	createInstrumentSample(java.lang.String description, long interval, int sampleCount, long leaseTime, int sampleType) Requests that a sample be created or that its lease be updated.
InstrumentSampleData[]	getInstrumentSamples() Returns an array of the Instrument Samples assigned to the Instrument.
int	getType() Returns the type of the Instrument.
boolean	isRegistered() Returns the registered flag of the remote object.

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

getName, getParent, isConfigured

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

getDescription, getStateVersion, update

Field Detail

INSTRUMENT_TYPE_NONE

public static final int INSTRUMENT_TYPE_NONE

Type which specifies that the type of a Instrument has not yet been determined.

See Also:

Constant Field Values

INSTRUMENT_TYPE_COUNTER

public static final int INSTRUMENT_TYPE_COUNTER

Type which identifies CounterInstruments.

See Also:

Constant Field Values

INSTRUMENT_TYPE_VALUE

public static final int INSTRUMENT_TYPE_VALUE

Type which identifies ValueInstruments.

See Also:

Constant Field Values

Method Detail

isRegistered

public boolean isRegistered()

Returns the registered flag of the remote object.

Returns:

The registered flag of the remote object.

getType

public int getType()

Returns the type of the Instrument. Possible values include InstrumentData.INSTRUMENT_TYPE_COUNTER, InstrumentData.INSTRUMENT_TYPE_VALUE or InstrumentData.INSTRUMENT_TYPE_NONE, if the type was never set.

Returns:

The type of the Instrument.

getInstrumentSamples

public InstrumentSampleData[] getInstrumentSamples()

Returns an array of the Instrument Samples assigned to the Instrument.

Returns:

An array of Instrument Samples.

createInstrumentSample

public boolean createInstrumentSample(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:

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.

Returns:

True if successful.