org.jolokia.backend

Class Config

java.lang.Object

org.jolokia.backend.Config

All Implemented Interfaces:

MBeanRegistration, ConfigMBean

public class Config
extends Object
implements ConfigMBean, MBeanRegistration

MBean for exporting various configuration tuning opportunities to the outside world.

Since:

Jun 12, 2009

Author:

roland

Field Summary

Fields inherited from interface org.jolokia.backend.ConfigMBean

LEGACY_OBJECT_NAME, OBJECT_NAME

Constructor Summary

Constructors

Constructor and Description
Config(HistoryStore pHistoryStore, DebugStore pDebugStore, String pOName) Constructor with the configurable objects as parameters.

Method Summary

Modifier and Type	Method and Description
String	debugInfo() Get latest debug information if debugging is switched on.
int	getHistoryMaxEntries() Number of global limit for history entries.
int	getHistorySize() Get the size in bytes which the history mechanism requires in total if serialized.
int	getMaxDebugEntries() Number of debug entries to remember
boolean	isDebug() Check, whether debugging is switched on
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
void	resetDebugInfo() Reset all debug information stored internally
void	resetHistoryEntries() Remove all history entries and switch off history tracking globally.
void	setDebug(boolean pSwitch) Set debugging to given state
void	setHistoryEntriesForAttribute(String pMBean, String pAttribute, String pPath, String pTarget, int pMaxEntries) Switch on history tracking for a specific attribute.
void	setHistoryEntriesForOperation(String pMBean, String pOperation, String pTarget, int pMaxEntries) Switch on history tracking for an operation.
void	setHistoryLimitForAttribute(String pMBean, String pAttribute, String pPath, String pTarget, int pMaxEntries, long pMaxDuration) Switch on history tracking for a specific attribute.
void	setHistoryLimitForOperation(String pMBean, String pOperation, String pTarget, int pMaxEntries, long pMaxDuration) Switch on history tracking for an operation.
void	setHistoryMaxEntries(int pLimit) Set the global history limit
void	setMaxDebugEntries(int pNumber) Set the number of debugging info to remember

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

public Config(HistoryStore pHistoryStore,
              DebugStore pDebugStore,
              String pOName)

Constructor with the configurable objects as parameters.

Parameters:

pHistoryStore - history store where to hold historical values

pDebugStore - debug store for holding debug messages

pOName - object name under which to register this MBean

Method Detail

setHistoryEntriesForAttribute

public void setHistoryEntriesForAttribute(String pMBean,
                                          String pAttribute,
                                          String pPath,
                                          String pTarget,
                                          int pMaxEntries)
                                   throws MalformedObjectNameException

Switch on history tracking for a specific attribute. If pMaxEntries is 0 history tracking is switched off.

Specified by:

setHistoryEntriesForAttribute in interface ConfigMBean

Parameters:

pMBean - MBean object name

pAttribute - attribute name

pPath - inner path (optional)

pTarget - remote target or null for a local mbean

pMaxEntries - max last entries to remember, if 0 history tracking is switched off.

Throws:

MalformedObjectNameException - if the given name is not proper object name

setHistoryLimitForAttribute

public void setHistoryLimitForAttribute(String pMBean,
                                        String pAttribute,
                                        String pPath,
                                        String pTarget,
                                        int pMaxEntries,
                                        long pMaxDuration)
                                 throws MalformedObjectNameException

Switch on history tracking for a specific attribute. If pMaxEntries and pMaxDuration is 0 then history tracking is switched off. If either pMaxEntries or pMaxDuration 0, then the given limit applies. If both are != 0, then both limits are applied simultaneously.

Specified by:

setHistoryLimitForAttribute in interface ConfigMBean

Parameters:

pMBean - MBean object name

pAttribute - attribute name

pPath - inner path (optional)

pTarget - remote target or null for a local mbean

pMaxEntries - max last entries to remember, if 0 history tracking is switched off.

pMaxDuration - maximum duration the maximum duration for how long to keep a value (in seconds)

Throws:

MalformedObjectNameException - if the given name is not proper object name

setHistoryEntriesForOperation

public void setHistoryEntriesForOperation(String pMBean,
                                          String pOperation,
                                          String pTarget,
                                          int pMaxEntries)
                                   throws MalformedObjectNameException

Switch on history tracking for an operation. If pMaxEntries is 0 history tracking is switched off. The return value of the operation will be tracked.

Specified by:

setHistoryEntriesForOperation in interface ConfigMBean

Parameters:

pMBean - MBean object name

pOperation - operation to track

pTarget - remote target or null for a loal mbean

pMaxEntries - max last entries to remember, if 0 history tracking is switched off.

Throws:

MalformedObjectNameException

setHistoryLimitForOperation

public void setHistoryLimitForOperation(String pMBean,
                                        String pOperation,
                                        String pTarget,
                                        int pMaxEntries,
                                        long pMaxDuration)
                                 throws MalformedObjectNameException

Switch on history tracking for an operation. If pMaxEntries and pMaxDuration is 0 history tracking is switched off. The return value of the operation will be tracked. If either pMaxEntries or pMaxDuration 0, then the given limit applies. If both are != 0, then both limits are applied simultaneously.

Specified by:

setHistoryLimitForOperation in interface ConfigMBean

Parameters:

pMBean - MBean object name

pOperation - operation to track

pTarget - remote target or null for a loal mbean

pMaxEntries - max last entries to remember, if 0 history tracking is switched off.

pMaxDuration - maximum duration the maximum duration for how long to keep a value (in seconds)

Throws:

MalformedObjectNameException

resetHistoryEntries

public void resetHistoryEntries()

Remove all history entries and switch off history tracking globally.

Specified by:

resetHistoryEntries in interface ConfigMBean

debugInfo

public String debugInfo()

Get latest debug information if debugging is switched on. The returned output will not take more than ConfigMBean.getMaxDebugEntries() lines.

Specified by:

debugInfo in interface ConfigMBean

Returns:

debug info in plain ascii.

resetDebugInfo

public void resetDebugInfo()

Reset all debug information stored internally

Specified by:

resetDebugInfo in interface ConfigMBean

getHistoryMaxEntries

public int getHistoryMaxEntries()

Number of global limit for history entries. No attribute historization can exceed this limit (i.e if in ConfigMBean.setHistoryLimitForAttribute(String, String, String, String, int, long) the pMaxEntries is set larger than this limit, the global limit will be taken}

Specified by:

getHistoryMaxEntries in interface ConfigMBean

Returns:

the global history limit

setHistoryMaxEntries

public void setHistoryMaxEntries(int pLimit)

Set the global history limit

Specified by:

setHistoryMaxEntries in interface ConfigMBean

Parameters:

pLimit - limit to set

isDebug

public boolean isDebug()

Check, whether debugging is switched on

Specified by:

isDebug in interface ConfigMBean

Returns:

state of debugging

setDebug

public void setDebug(boolean pSwitch)

Set debugging to given state

Specified by:

setDebug in interface ConfigMBean

Parameters:

pSwitch - true, if debugging should be switched on, false otherwise

getMaxDebugEntries

public int getMaxDebugEntries()

Number of debug entries to remember

Specified by:

getMaxDebugEntries in interface ConfigMBean

Returns:

number of debug entries

setMaxDebugEntries

public void setMaxDebugEntries(int pNumber)

Set the number of debugging info to remember

Specified by:

setMaxDebugEntries in interface ConfigMBean

Parameters:

pNumber - entries to set

getHistorySize

public int getHistorySize()

Get the size in bytes which the history mechanism requires in total if serialized.

Specified by:

getHistorySize in interface ConfigMBean

Returns:

size of the complete history in bytes

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws MalformedObjectNameException

Specified by:

preRegister in interface MBeanRegistration

Throws:

MalformedObjectNameException

postRegister

public void postRegister(Boolean registrationDone)

Specified by:

postRegister in interface MBeanRegistration

preDeregister

public void preDeregister()

Specified by:

preDeregister in interface MBeanRegistration

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration