org.jolokia.detector

Class ServerHandle

java.lang.Object

org.jolokia.detector.ServerHandle

public class ServerHandle
extends Object

Information about the the server product the agent is running in.

Since:

05.11.10

Author:

roland

Constructor Summary

Constructors

Constructor and Description
ServerHandle(String vendor, String product, String version, Map<String,String> extraInfo) Constructor

Method Summary

Modifier and Type	Method and Description
protected org.json.simple.JSONObject	getDetectorOptions(Configuration pConfig, LogHandler pLogHandler) Get the optional options used for detectors.
Map<String,String>	getExtraInfo(MBeanServerExecutor pServerManager) Get extra information specific to a server.
String	getProduct() Get the name of the server this agent is running in
String	getVendor() Get name of vendor
String	getVersion() Get version number of the agent server
void	postDetect(MBeanServerExecutor pServerManager, Configuration pConfig, LogHandler pLoghandler) Hook called after the detection phase.
void	preDispatch(MBeanServerExecutor pMBeanServerExecutor, JmxRequest pJmxReq) Hook for performing certain workarounds/pre processing just before a request gets dispatched
ObjectName	registerMBeanAtServer(MBeanServer pServer, Object pMBean, String pName) Register a MBean at the dedicated server.
org.json.simple.JSONObject	toJSONObject(MBeanServerExecutor pServerManager) Return this info as an JSONObject

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerHandle

public ServerHandle(String vendor,
                    String product,
                    String version,
                    Map<String,String> extraInfo)

Constructor

Parameters:

vendor - product vendor (like RedHat or Oracle)

product - name of the product

version - version

extraInfo - free form extra information

Method Detail

getVendor

public String getVendor()

Get name of vendor

getProduct

public String getProduct()

Get the name of the server this agent is running in

Returns:

server name

getVersion

public String getVersion()

Get version number of the agent server

Returns:

version number

getExtraInfo

public Map<String,String> getExtraInfo(MBeanServerExecutor pServerManager)

Get extra information specific to a server. A subclass can overwrite this in order to provide dynamice information on the server which gets calculated afresh on each invokation.

Parameters:

pServerManager - MBeanServers to query

Returns:

a map of extra info or null if no extra information is given.

preDispatch

public void preDispatch(MBeanServerExecutor pMBeanServerExecutor,
                        JmxRequest pJmxReq)

Hook for performing certain workarounds/pre processing just before a request gets dispatched

Parameters:

pMBeanServerExecutor - the detected MBeanServers

pJmxReq - the request to dispatch

postDetect

public void postDetect(MBeanServerExecutor pServerManager,
                       Configuration pConfig,
                       LogHandler pLoghandler)

Hook called after the detection phase. This can be used by a handle to perform some specific action, possibly based on the configuration given. The default is a no-op.

Parameters:

pServerManager -

pConfig - agent configuration

pLoghandler - logger to use for logging any error.

registerMBeanAtServer

public ObjectName registerMBeanAtServer(MBeanServer pServer,
                                        Object pMBean,
                                        String pName)
                                 throws MBeanRegistrationException,
                                        InstanceAlreadyExistsException,
                                        NotCompliantMBeanException,
                                        MalformedObjectNameException

Register a MBean at the dedicated server. This method can be overridden if something special registration procedure is required, like for using the specific name for the registration or deligating the namin to MBean to register.

Parameters:

pServer - server an MBean should be registered

pMBean - the MBean to register

pName - an optional name under which the MBean should be registered. Can be null

Returns:

the object name of the registered MBean

Throws:

MBeanRegistrationException - when registration failed

InstanceAlreadyExistsException - when there is already MBean with this name

NotCompliantMBeanException

MalformedObjectNameException - if the name is not valid

toJSONObject

public org.json.simple.JSONObject toJSONObject(MBeanServerExecutor pServerManager)

Return this info as an JSONObject

Parameters:

pServerManager - servers, for which dynamic part might be queried

Returns:

this object in JSON representation

getDetectorOptions

protected org.json.simple.JSONObject getDetectorOptions(Configuration pConfig,
                                                        LogHandler pLogHandler)

Get the optional options used for detectors. This should be a JSON string specifying all options for all detectors. Keys are the name of the detector's product, the values are JSON object containing specific parameters for this agent. E.g.

    {
        "glassfish" : { "bootAmx": true  }
    }
 

Parameters:

pConfig - the agent configuration

pLogHandler - a log handler for putting out error messages

Returns:

the detector specific configuration