Package org.apache.openjpa.instrumentation.jmx

Interface JMXInstrument

All Superinterfaces:

Instrument

All Known Implementing Classes:

DataCacheJMXInstrument, PreparedQueryCacheJMXInstrument, QueryCacheJMXInstrument

public interface JMXInstrument
extends Instrument

Interface for JMX-specific instruments

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConfigId()	Sets the config id for the instrument.
java.lang.String	getContextRef()	Gets the context reference for the instrument.
javax.management.ObjectName	getObjectName()	Returns the JMX object name for the instrument
void	setConfigId(java.lang.String cid)	Gets the config id for the instrument.
void	setContextRef(java.lang.String cref)	Sets the context reference for the instrument.

Methods inherited from interface org.apache.openjpa.lib.instrumentation.Instrument

getContext, getLevel, getName, getOptions, getProvider, initialize, isStarted, restart, setContext, setOptions, setProvider, setStarted, start, stop

Method Detail

getObjectName

javax.management.ObjectName getObjectName()

Returns the JMX object name for the instrument

setContextRef

void setContextRef(java.lang.String cref)

Sets the context reference for the instrument. Required to register the instrument under a unique id.

Parameters:

cref - the context reference for the instrument

getContextRef

java.lang.String getContextRef()

Gets the context reference for the instrument. Required to register the instrument under a unique id.

Parameters:

cref - the context reference for the instrument

getConfigId

java.lang.String getConfigId()

Sets the config id for the instrument. Required to register the instrument under a unique id.

Returns:

the config id of the instrument

setConfigId

void setConfigId(java.lang.String cid)

Gets the config id for the instrument. Required to register the instrument under a unique id.

Parameters:

cid - the config id of the instrument