|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.excalibur.instrument.manager.impl.InstrumentDescriptorImpl
Describes a Instrument and acts as a Proxy to protect the original Instrument.
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. |
InstrumentSampleDescriptor |
createInstrumentSample(java.lang.String sampleDescription,
long sampleInterval,
int sampleSize,
long sampleLease,
int sampleType)
Returns a InstrumentSampleDescriptor based on its name. |
java.lang.String |
getDescription()
Gets the description of the Instrument. |
InstrumentableDescriptor |
getInstrumentableDescriptor()
Returns a reference to the descriptor of the Instrumentable of the instrument. |
InstrumentSampleDescriptor |
getInstrumentSampleDescriptor(java.lang.String instrumentSampleName)
Returns a InstrumentSampleDescriptor based on its name. |
InstrumentSampleDescriptor[] |
getInstrumentSampleDescriptors()
Returns an array of Descriptors for the InstrumentSamples configured for this Instrument. |
java.lang.String |
getName()
Gets the name for the Instrument. |
int |
getStateVersion()
Returns the stateVersion of the instrument. |
int |
getType()
Returns the type of the Instrument. |
boolean |
isConfigured()
Returns true if the Instrument was configured in the instrumentables section of the configuration. |
boolean |
isRegistered()
Returns true if the Instrument was registered with the Instrument Manager. |
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 class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public boolean isConfigured()
isConfigured
in interface InstrumentDescriptor
public boolean isRegistered()
isRegistered
in interface InstrumentDescriptor
public java.lang.String getName()
getName
in interface InstrumentDescriptor
public java.lang.String getDescription()
getDescription
in interface InstrumentDescriptor
public int getType()
getType
in interface InstrumentDescriptor
public InstrumentableDescriptor getInstrumentableDescriptor()
getInstrumentableDescriptor
in interface InstrumentDescriptor
public void addCounterInstrumentListener(CounterInstrumentListener listener)
addCounterInstrumentListener
in interface InstrumentDescriptor
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)
removeCounterInstrumentListener
in interface InstrumentDescriptor
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)
addValueInstrumentListener
in interface InstrumentDescriptor
listener
- ValueInstrumentListener which will start receiving
profile updates.
java.lang.IllegalStateException
- If the Instrument's type is not
DefaultInstrumentManager.INSTRUMENT_TYPE_VALUE.public void removeValueInstrumentListener(ValueInstrumentListener listener)
removeValueInstrumentListener
in interface InstrumentDescriptor
listener
- InstrumentListener which will stop receiving profile
events.
java.lang.IllegalStateException
- If the Instrument's type is not
DefaultInstrumentManager.INSTRUMENT_TYPE_VALUE.public InstrumentSampleDescriptor getInstrumentSampleDescriptor(java.lang.String instrumentSampleName) throws NoSuchInstrumentSampleException
getInstrumentSampleDescriptor
in interface InstrumentDescriptor
instrumentSampleName
- Name of the InstrumentSample being requested.
NoSuchInstrumentSampleException
- If the specified InstrumentSample
does not exist.public InstrumentSampleDescriptor createInstrumentSample(java.lang.String sampleDescription, long sampleInterval, int sampleSize, long sampleLease, int sampleType)
createInstrumentSample
in interface InstrumentDescriptor
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 InstrumentSampleDescriptor[] getInstrumentSampleDescriptors()
getInstrumentSampleDescriptors
in interface InstrumentDescriptor
public int getStateVersion()
getStateVersion
in interface InstrumentDescriptor
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |