org.jolokia.backend

Interface ConfigMBean

All Known Implementing Classes:

Config

public interface ConfigMBean

MBean for handling configuration issues from outside.

Since:

Jun 12, 2009

Author:

roland

Field Summary

Fields

Modifier and Type	Field and Description
static String	LEGACY_OBJECT_NAME
static String	OBJECT_NAME

Method Summary

Methods

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	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) Deprecated. use setHistoryLimitForAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, long) instead
void	setHistoryEntriesForOperation(String pMBean, String pOperation, String pTarget, int pMaxEntries) Deprecated. use setHistoryLimitForOperation(java.lang.String, java.lang.String, java.lang.String, int, long) instead
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

Field Detail

OBJECT_NAME

static final String OBJECT_NAME

See Also:

Constant Field Values

LEGACY_OBJECT_NAME

static final String LEGACY_OBJECT_NAME

See Also:

Constant Field Values

Method Detail

setHistoryEntriesForAttribute

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

Deprecated. use setHistoryLimitForAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, long) instead

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

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

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.

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

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

Deprecated. use setHistoryLimitForOperation(java.lang.String, java.lang.String, java.lang.String, int, long) instead

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.

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

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.

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

void resetHistoryEntries()

Remove all history entries and switch off history tracking globally.

debugInfo

String debugInfo()

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

Returns:

debug info in plain ascii.

resetDebugInfo

void resetDebugInfo()

Reset all debug information stored internally

getHistorySize

int getHistorySize()
                   throws IOException

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

Returns:

size of the complete history in bytes

Throws:

IOException - if serialization (which is required for the size determination) fails.

getHistoryMaxEntries

int getHistoryMaxEntries()

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

Returns:

the global history limit

setHistoryMaxEntries

void setHistoryMaxEntries(int pLimit)

Set the global history limit

Parameters:

pLimit - limit to set

isDebug

boolean isDebug()

Check, whether debugging is switched on

Returns:

state of debugging

setDebug

void setDebug(boolean pSwitch)

Set debugging to given state

Parameters:

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

getMaxDebugEntries

int getMaxDebugEntries()

Number of debug entries to remember

Returns:

number of debug entries

setMaxDebugEntries

void setMaxDebugEntries(int pNumber)

Set the number of debugging info to remember

Parameters:

pNumber - entries to set