| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface InstrumentationProvider
Pluggable instrumentation providers (ex. JMX) must implement this interface. It provides methods for controlling the provider and the instruments instrumented by the provider.
| Method Summary | |
|---|---|
|  void | addInstrument(Instrument instrument)Adds an instrument to this providers list of managed instruments. | 
|  Configuration | getConfiguration()Gets the configuration associated with the instrumentation provider | 
|  String | getInstrument()Returns the string-based list of instruments directly configured by this provider via setInstrument. | 
|  String[] | getInstrumentAliases()Returns an string array of identifier to class name aliases for instruments known to the instrumentation provider. | 
|  Instrument | getInstrumentByName(String name)Returns an instrument instrumented by this provider by name | 
|  Set<Instrument> | getInstruments()Gets all instruments instrumented by this provider | 
|  String | getOptions()Gets configuration options for this provider | 
|  void | initializeInstrument(Instrument instrument,
                     Object context)Initializes an instrument within the provided context. | 
|  void | initializeInstrument(Instrument instrument,
                     String options,
                     Object context)Initializes an instrument within the provided options and context. | 
|  boolean | isStarted()Whether the instrumentation provider started | 
|  void | removeInstrumentByName(String name)Removes an instrument instrumented by this provider by name | 
|  void | setInstrument(String instruments)Used to associate one or more instruments to a provider. | 
|  void | setOptions(String options)Sets configuration options for this provider | 
|  void | start()Stops the instrumentation provider | 
|  void | startInstrument(Instrument instrument)Starts an instrument | 
|  void | startInstruments(InstrumentationLevel level,
                 Object context)Starts all instruments of the specified instrumentation level and context. | 
|  void | stop()Starts the instrumentation provider | 
|  void | stopInstrument(Instrument instrument)Stops an instrument | 
|  void | stopInstrument(Instrument instrument,
               boolean force)Stops an instrument, forcing the stop, if necessary. | 
|  void | stopInstruments(InstrumentationLevel level,
                Object context)Stops all instruments of the specified instrumentation level and context. | 
| Method Detail | 
|---|
boolean isStarted()
void stop()
void start()
Configuration getConfiguration()
void setInstrument(String instruments)
instruments - one or more instrument class names or aliasesString getInstrument()
void setOptions(String options)
options - String getOptions()
options - String[] getInstrumentAliases()
void addInstrument(Instrument instrument)
instrument - 
void stopInstruments(InstrumentationLevel level,
                     Object context)
level - instrumentation levelcontext - instrumentation context (factory, broker, config)
void startInstruments(InstrumentationLevel level,
                      Object context)
level - instrumentation levelcontext - instrumentation context (factory, broker, config)
void initializeInstrument(Instrument instrument,
                          Object context)
instrument - an instrumentcontext - instrumentation context (factory, broker, config)
void initializeInstrument(Instrument instrument,
                          String options,
                          Object context)
instrument - an instrumentoptions - configuration options to provide the instrument during initializationcontext - instrumentation context (factory, broker, config)Instrument getInstrumentByName(String name)
name - the name of the instrument to return
void removeInstrumentByName(String name)
name - the name of the instrument to removeSet<Instrument> getInstruments()
void startInstrument(Instrument instrument)
instrument - this instrument to startvoid stopInstrument(Instrument instrument)
instrument - the instrument to stop
void stopInstrument(Instrument instrument,
                    boolean force)
instrument - the instrument to stopforce - forces the stop if the instrument does not stop gracefully.| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||