org.jolokia.detector

Class AbstractServerDetector

java.lang.Object

org.jolokia.detector.AbstractServerDetector

All Implemented Interfaces:

ServerDetector

Direct Known Subclasses:

ActiveMQDetector, GeronimoDetector, GlassfishDetector, JBossDetector, JettyDetector, LightstreamerDetector, TomcatDetector, WeblogicDetector, WebsphereDetector

public abstract class AbstractServerDetector
extends Object
implements ServerDetector

Base class for server detectors

Since:

05.11.10

Author:

roland

Constructor Summary

Constructors

Constructor and Description
AbstractServerDetector()

Method Summary

Modifier and Type	Method and Description
void	addMBeanServers(Set<MBeanServerConnection> pServers) Do nothing by default, leaving the implementation optional for each specific detector
protected String	getAttributeValue(MBeanServerExecutor pMBeanServerExecutor, ObjectName pMBean, String pAttribute) Get the string representation of an attribute
protected String	getAttributeValue(MBeanServerExecutor pMBeanServerExecutor, String pMBean, String pAttribute) Get the string representation of an attribute
protected String	getSingleStringAttribute(MBeanServerExecutor pMBeanServerExecutor, String pMBeanName, String pAttribute) Get a single attribute for a given MBeanName pattern.
protected String	getVersionFromJsr77(MBeanServerExecutor pMbeanServers) Get the version number from a JSR-77 compliant server
protected boolean	isClassLoaded(String className, Instrumentation instrumentation) Tests if the given class name has been loaded by the JVM.
void	jvmAgentStartup(Instrumentation instrumentation) By default do nothing during JVM agent startup
protected boolean	mBeanExists(MBeanServerExecutor pMBeanServerManger, String pObjectName) Check whether a certain MBean exists
protected Set<ObjectName>	searchMBeans(MBeanServerExecutor pMBeanServerExecutor, String pMbeanPattern) Check for the existence of a certain MBean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jolokia.detector.ServerDetector

detect

Constructor Detail

AbstractServerDetector

public AbstractServerDetector()

Method Detail

searchMBeans

protected Set<ObjectName> searchMBeans(MBeanServerExecutor pMBeanServerExecutor,
                                       String pMbeanPattern)

Check for the existence of a certain MBean. All known MBeanServers are queried

Parameters:

pMBeanServerExecutor - mbean servers to query for

pMbeanPattern - MBean name pattern for MBeans to check for

Returns:

set of ObjectNames if the pattern matches, or an empty set if not mbean has been found

mBeanExists

protected boolean mBeanExists(MBeanServerExecutor pMBeanServerManger,
                              String pObjectName)

Check whether a certain MBean exists

Parameters:

pMBeanServerManger - set of MBeanServers to query for

pObjectName - the objectname to check. Can be a pattern in which case this method return true if one or more MBeans of all MBeanServers match this pattern

Returns:

true if at least one MBean of the given name (or pattern) exists

getAttributeValue

protected String getAttributeValue(MBeanServerExecutor pMBeanServerExecutor,
                                   String pMBean,
                                   String pAttribute)

Get the string representation of an attribute

Parameters:

pMBeanServerExecutor - set of MBeanServers to query. The first one wins.

pMBean - object name of MBean to lookup

pAttribute - attribute to lookup

Returns:

string value of attribute or null if the attribute could not be fetched

getAttributeValue

protected String getAttributeValue(MBeanServerExecutor pMBeanServerExecutor,
                                   ObjectName pMBean,
                                   String pAttribute)

Get the string representation of an attribute

Parameters:

pMBeanServerExecutor - set of MBeanServers to query. The first one wins.

pMBean - name of MBean to lookup

pAttribute - attribute to lookup

Returns:

string value of attribute or null if the attribute could not be fetched

getSingleStringAttribute

protected String getSingleStringAttribute(MBeanServerExecutor pMBeanServerExecutor,
                                          String pMBeanName,
                                          String pAttribute)

Get a single attribute for a given MBeanName pattern.

Parameters:

pMBeanServerExecutor - MBeanServer manager to query

pMBeanName - a MBean name or pattern. If multiple MBeans are found, each is queried for the attribute

pAttribute - the attribute to lookup

Returns:

the string value of the attribute or null if either no MBeans could be found, or 0 or more than 1 attribute are found on those mbeans

getVersionFromJsr77

protected String getVersionFromJsr77(MBeanServerExecutor pMbeanServers)

Get the version number from a JSR-77 compliant server

Parameters:

pMbeanServers - servers to query

Returns:

version number or null if not found.

addMBeanServers

public void addMBeanServers(Set<MBeanServerConnection> pServers)

Do nothing by default, leaving the implementation optional for each specific detector

Specified by:

addMBeanServers in interface ServerDetector

Parameters:

pServers - servers to add

jvmAgentStartup

public void jvmAgentStartup(Instrumentation instrumentation)

By default do nothing during JVM agent startup

Specified by:

jvmAgentStartup in interface ServerDetector

Parameters:

instrumentation - the Instrumentation implementation

isClassLoaded

protected boolean isClassLoaded(String className,
                                Instrumentation instrumentation)

Tests if the given class name has been loaded by the JVM. Don't use this method in case you have access to the class loader which will be loading the class because the used approach is not very efficient.

Parameters:

className - the name of the class to check

instrumentation -

Returns:

true if the class has been loaded by the JVM

Throws:

IllegalArgumentException - in case instrumentation or the provided class is null