|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Describes a Instrument and acts as a Proxy to protect the original Instrument. Methods defined by the Local interface should only be accessed from within the same JVM for performance reasons.
| Method Summary | |
void |
addCounterInstrumentListener(CounterInstrumentListener listener)Adds a CounterInstrumentListener to the list of listeners which will receive updates of the value of the Instrument. |
void |
addValueInstrumentListener(ValueInstrumentListener listener)Adds a ValueInstrumentListener to the list of listeners which will receive updates of the value of the Instrument. |
InstrumentSampleDescriptorLocal |
createInstrumentSampleLocal(java.lang.String sampleDescription, long sampleInterval, int sampleSize, long sampleLease, int sampleType)Returns a InstrumentSampleDescriptorLocal based on its name. |
InstrumentableDescriptorLocal |
getInstrumentableDescriptorLocal()Returns a reference to the descriptor of the Instrumentable of the instrument. |
InstrumentSampleDescriptorLocal |
getInstrumentSampleDescriptorLocal(java.lang.String instrumentSampleName)Returns a InstrumentSampleDescriptorLocal based on its name. |
InstrumentSampleDescriptorLocal[] |
getInstrumentSampleDescriptorLocals()Returns an array of Descriptors for the InstrumentSamples configured for this Instrument. |
void |
removeCounterInstrumentListener(CounterInstrumentListener listener)Removes a InstrumentListener from the list of listeners which will receive profile events. |
void |
removeValueInstrumentListener(ValueInstrumentListener listener)Removes a InstrumentListener from the list of listeners which will receive profile events. |
| Methods inherited from interface org.apache.excalibur.instrument.manager.interfaces.InstrumentDescriptor |
createInstrumentSample, getDescription, getInstrumentableDescriptor, getInstrumentSampleDescriptor, getInstrumentSampleDescriptors, getName, getStateVersion, getType, isConfigured, isRegistered |
| Method Detail |
public InstrumentableDescriptorLocal getInstrumentableDescriptorLocal()
public void addCounterInstrumentListener(CounterInstrumentListener listener)
listener - CounterInstrumentListener which will start receiving profile updates.java.lang.IllegalStateException - If the Instrument's type is not InstrumentManager.PROFILE_POINT_TYPE_COUNTER.public void removeCounterInstrumentListener(CounterInstrumentListener listener)
listener - InstrumentListener which will stop receiving profile events.java.lang.IllegalStateException - If the Instrument's type is not InstrumentManager.PROFILE_POINT_TYPE_COUNTER.public void addValueInstrumentListener(ValueInstrumentListener listener)
listener - ValueInstrumentListener which will start receiving profile updates.java.lang.IllegalStateException - If the Instrument's type is not InstrumentManager.PROFILE_POINT_TYPE_VALUE.public void removeValueInstrumentListener(ValueInstrumentListener listener)
listener - InstrumentListener which will stop receiving profile events.java.lang.IllegalStateException - If the Instrument's type is not InstrumentManager.PROFILE_POINT_TYPE_VALUE.
public InstrumentSampleDescriptorLocal getInstrumentSampleDescriptorLocal(java.lang.String instrumentSampleName)
throws NoSuchInstrumentSampleException
instrumentSampleName - Name of the InstrumentSample being requested.NoSuchInstrumentSampleException - If the specified InstrumentSample does not exist.
public InstrumentSampleDescriptorLocal createInstrumentSampleLocal(java.lang.String sampleDescription,
long sampleInterval,
int sampleSize,
long sampleLease,
int sampleType)
sampleDescription - Description to assign to the new Sample.sampleInterval - Sample interval to use in the new Sample.sampleLease - Requested lease time for the new Sample in milliseconds. The InstrumentManager may grant a lease which is shorter or longer than the requested period.sampleType - Type of sample to request. Must be one of the following: InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_COUNTER, InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MINIMUM, InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MAXIMUM, InstrumentManagerClient.INSTRUMENT_SAMPLE_TYPE_MEAN.NoSuchInstrumentSampleException - If the specified InstrumentSample does not exist.public InstrumentSampleDescriptorLocal[] getInstrumentSampleDescriptorLocals()
|
Keel 2.1RC2 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||