Package org.apache.camel.api.management.mbean

Interface ManagedBacklogDebuggerMBean

public interface ManagedBacklogDebuggerMBean

Method Summary

Modifier and Type	Method	Description
void	addBreakpoint(String nodeId)
void	addConditionalBreakpoint(String nodeId, String language, String predicate)
void	attach()
Set<String>	breakpoints()
void	detach()
void	disableBreakpoint(String nodeId)
void	disableDebugger()
String	dumpTracedMessagesAsJSon(String nodeId)
String	dumpTracedMessagesAsXml(String nodeId)
String	dumpTracedMessagesAsXml(String nodeId, boolean includeExchangeProperties)	Deprecated.
void	enableBreakpoint(String nodeId)
void	enableDebugger()
String	evaluateExpressionAtBreakpoint(String nodeId, String language, String expression)
Object	evaluateExpressionAtBreakpoint(String nodeId, String language, String expression, String resultType)
int	getBodyMaxChars()
String	getCamelId()
String	getCamelManagementName()
long	getDebugCounter()
long	getFallbackTimeout()
String	getLoggingLevel()
boolean	isBodyIncludeFiles()
boolean	isBodyIncludeStreams()
boolean	isEnabled()
boolean	isIncludeExchangeProperties()
boolean	isIncludeExchangeVariables()
boolean	isSingleStepMode()
boolean	isStandby()
boolean	isSuspendedMode()
String	messageHistoryOnBreakpointAsXml(String nodeId)
void	removeAllBreakpoints()
void	removeBreakpoint(String nodeId)
void	removeExchangePropertyOnBreakpoint(String nodeId, String exchangePropertyName)
void	removeExchangeVariableOnBreakpoint(String nodeId, String variableName)
void	removeMessageBodyOnBreakpoint(String nodeId)
void	removeMessageHeaderOnBreakpoint(String nodeId, String headerName)
void	resetDebugCounter()
void	resumeAll()
void	resumeBreakpoint(String nodeId)
void	setBodyIncludeFiles(boolean bodyIncludeFiles)
void	setBodyIncludeStreams(boolean bodyIncludeStreams)
void	setBodyMaxChars(int bodyMaxChars)
void	setExchangePropertyOnBreakpoint(String nodeId, String exchangePropertyName, Object value)
void	setExchangePropertyOnBreakpoint(String nodeId, String exchangePropertyName, Object value, String type)
void	setExchangeVariableOnBreakpoint(String nodeId, String variableName, Object value)
void	setExchangeVariableOnBreakpoint(String nodeId, String variableName, Object value, String type)
void	setFallbackTimeout(long fallbackTimeout)
void	setIncludeExchangeProperties(boolean includeExchangeProperties)
void	setIncludeExchangeVariables(boolean includeExchangeVariables)
void	setLoggingLevel(String level)
void	setMessageBodyOnBreakpoint(String nodeId, Object body)
void	setMessageBodyOnBreakpoint(String nodeId, Object body, String type)
void	setMessageHeaderOnBreakpoint(String nodeId, String headerName, Object value)
void	setMessageHeaderOnBreakpoint(String nodeId, String headerName, Object value, String type)
void	step()
void	stepBreakpoint(String nodeId)
Set<String>	suspendedBreakpointNodeIds()
String	validateConditionalBreakpoint(String language, String predicate)

Method Details

getCamelId

@ManagedAttribute(description="Camel ID")
String getCamelId()

getCamelManagementName

@ManagedAttribute(description="Camel ManagementName")
String getCamelManagementName()

getLoggingLevel

@ManagedAttribute(description="Logging Level")
String getLoggingLevel()

setLoggingLevel

@ManagedAttribute(description="Logging Level")
void setLoggingLevel(String level)

isEnabled

@ManagedAttribute(description="Is debugger enabled")
boolean isEnabled()

isStandby

@ManagedAttribute(description="Is debugger standby")
boolean isStandby()

enableDebugger

@ManagedOperation(description="Enable the debugger")
void enableDebugger()

disableDebugger

@ManagedOperation(description="Disable the debugger")
void disableDebugger()

addBreakpoint

@ManagedOperation(description="Add a breakpoint at the given node id")
void addBreakpoint(String nodeId)

addConditionalBreakpoint

@ManagedOperation(description="Add a conditional breakpoint at the given node id")
void addConditionalBreakpoint(String nodeId,
 String language,
 String predicate)

removeBreakpoint

@ManagedOperation(description="Remote the breakpoint from the given node id (will resume suspend breakpoint first)")
void removeBreakpoint(String nodeId)

removeAllBreakpoints

@ManagedOperation(description="Remote all breakpoints (will resume all suspend breakpoints first and exists single step mode)")
void removeAllBreakpoints()

resumeBreakpoint

@ManagedOperation(description="Resume running from the suspended breakpoint at the given node id")
void resumeBreakpoint(String nodeId)

setMessageBodyOnBreakpoint

@ManagedOperation(description="Updates the message body (uses same type as old body) on the suspended breakpoint at the given node id")
void setMessageBodyOnBreakpoint(String nodeId,
 Object body)

setMessageBodyOnBreakpoint

@ManagedOperation(description="Updates the message body (with a new type) on the suspended breakpoint at the given node id")
void setMessageBodyOnBreakpoint(String nodeId,
 Object body,
 String type)

removeMessageBodyOnBreakpoint

@ManagedOperation(description="Removes the message body on the suspended breakpoint at the given node id")
void removeMessageBodyOnBreakpoint(String nodeId)

setMessageHeaderOnBreakpoint

@ManagedOperation(description="Updates/adds the message header (uses same type as old header value) on the suspended breakpoint at the given node id")
void setMessageHeaderOnBreakpoint(String nodeId,
 String headerName,
 Object value)

removeMessageHeaderOnBreakpoint

@ManagedOperation(description="Removes the message header on the suspended breakpoint at the given node id")
void removeMessageHeaderOnBreakpoint(String nodeId,
 String headerName)

setMessageHeaderOnBreakpoint

@ManagedOperation(description="Updates/adds the message header (with a new type) on the suspended breakpoint at the given node id")
void setMessageHeaderOnBreakpoint(String nodeId,
 String headerName,
 Object value,
 String type)

resumeAll

@ManagedOperation(description="Resume running any suspended breakpoints, and exits step mode")
void resumeAll()

stepBreakpoint

@ManagedOperation(description="Starts single step debugging from the suspended breakpoint at the given node id")
void stepBreakpoint(String nodeId)

isSuspendedMode

@ManagedAttribute(description="Suspended mode will suspend all exchanges until a remote debugger is attached")
boolean isSuspendedMode()

isSingleStepMode

@ManagedAttribute(description="Whether currently in step mode")
boolean isSingleStepMode()

step

@ManagedOperation(description="Steps to next node in step mode")
void step()

breakpoints

@ManagedOperation(description="Return the node ids which has breakpoints")
Set<String> breakpoints()

suspendedBreakpointNodeIds

@ManagedOperation(description="Return the node ids which is currently suspended")
Set<String> suspendedBreakpointNodeIds()

disableBreakpoint

@ManagedOperation(description="Disables a breakpoint")
void disableBreakpoint(String nodeId)

enableBreakpoint

@ManagedOperation(description="Enables a breakpoint which has been disabled")
void enableBreakpoint(String nodeId)

getBodyMaxChars

@ManagedAttribute(description="Number of maximum chars in the message body in the trace message. Use zero or negative value to have unlimited size.")
int getBodyMaxChars()

setBodyMaxChars

@ManagedAttribute(description="Number of maximum chars in the message body in the trace message. Use zero or negative value to have unlimited size.")
void setBodyMaxChars(int bodyMaxChars)

getFallbackTimeout

@ManagedAttribute(description="Fallback Timeout in seconds when block the message processing in Camel")
long getFallbackTimeout()

setFallbackTimeout

@ManagedAttribute(description="Fallback Timeout in seconds when block the message processing in Camel")
void setFallbackTimeout(long fallbackTimeout)

isBodyIncludeStreams

@ManagedAttribute(description="Whether to include stream based message body in the trace message")
boolean isBodyIncludeStreams()

setBodyIncludeStreams

@ManagedAttribute(description="Whether to include stream based message body in the trace message")
void setBodyIncludeStreams(boolean bodyIncludeStreams)

isBodyIncludeFiles

@ManagedAttribute(description="Whether to include file based message body in the trace message.")
boolean isBodyIncludeFiles()

setBodyIncludeFiles

@ManagedAttribute(description="Whether to include file based message body in the trace message.")
void setBodyIncludeFiles(boolean bodyIncludeFiles)

isIncludeExchangeProperties

@ManagedAttribute(description="Whether to include exchange properties in the trace message.")
boolean isIncludeExchangeProperties()

setIncludeExchangeProperties

@ManagedAttribute(description="Whether to include exchange properties in the trace message.")
void setIncludeExchangeProperties(boolean includeExchangeProperties)

isIncludeExchangeVariables

@ManagedAttribute(description="Whether to include exchange variables in the trace message.")
boolean isIncludeExchangeVariables()

setIncludeExchangeVariables

@ManagedAttribute(description="Whether to include exchange variables in the trace message.")
void setIncludeExchangeVariables(boolean includeExchangeVariables)

dumpTracedMessagesAsXml

@ManagedOperation(description="Dumps the messages in XML format from the suspended breakpoint at the given node.")
String dumpTracedMessagesAsXml(String nodeId)

dumpTracedMessagesAsXml

@ManagedOperation(description="Dumps the messages in XML format from the suspended breakpoint at the given node.")
@Deprecated
String dumpTracedMessagesAsXml(String nodeId,
 boolean includeExchangeProperties)

Deprecated.

dumpTracedMessagesAsJSon

@ManagedOperation(description="Dumps the messages in JSon format from the suspended breakpoint at the given node.")
String dumpTracedMessagesAsJSon(String nodeId)

getDebugCounter

@ManagedAttribute(description="Number of total debugged messages")
long getDebugCounter()

resetDebugCounter

@ManagedOperation(description="Resets the debug counter")
void resetDebugCounter()

validateConditionalBreakpoint

@ManagedOperation(description="Used for validating if a given breakpoint condition (predicate) is valid or not")
String validateConditionalBreakpoint(String language,
 String predicate)

evaluateExpressionAtBreakpoint

@ManagedOperation(description="Evaluates the expression at a given breakpoint node id")
Object evaluateExpressionAtBreakpoint(String nodeId,
 String language,
 String expression,
 String resultType)

evaluateExpressionAtBreakpoint

@ManagedOperation(description="Evaluates the expression at a given breakpoint node id and returns the result as String")
String evaluateExpressionAtBreakpoint(String nodeId,
 String language,
 String expression)

setExchangePropertyOnBreakpoint

@ManagedOperation(description="Updates/adds the exchange property (uses same type as old exchange property value) on the suspended breakpoint at the given node id")
void setExchangePropertyOnBreakpoint(String nodeId,
 String exchangePropertyName,
 Object value)

setExchangePropertyOnBreakpoint

@ManagedOperation(description="Updates/adds the exchange property (with a new type) on the suspended breakpoint at the given node id")
void setExchangePropertyOnBreakpoint(String nodeId,
 String exchangePropertyName,
 Object value,
 String type)

removeExchangePropertyOnBreakpoint

@ManagedOperation(description="Removes the exchange property on the suspended breakpoint at the given node id")
void removeExchangePropertyOnBreakpoint(String nodeId,
 String exchangePropertyName)

setExchangeVariableOnBreakpoint

@ManagedOperation(description="Updates/adds the exchange variable (uses same type as old variableName value) on the suspended breakpoint at the given node id")
void setExchangeVariableOnBreakpoint(String nodeId,
 String variableName,
 Object value)

setExchangeVariableOnBreakpoint

@ManagedOperation(description="Updates/adds the exchange variable (with a new type) on the suspended breakpoint at the given node id")
void setExchangeVariableOnBreakpoint(String nodeId,
 String variableName,
 Object value,
 String type)

removeExchangeVariableOnBreakpoint

@ManagedOperation(description="Removes the exchange variable on the suspended breakpoint at the given node id")
void removeExchangeVariableOnBreakpoint(String nodeId,
 String variableName)

messageHistoryOnBreakpointAsXml

@ManagedOperation(description="Returns the message history at the given node id as XML")
String messageHistoryOnBreakpointAsXml(String nodeId)

attach

@ManagedOperation(description="Attach the debugger")
void attach()

detach

@ManagedOperation(description="Detach the debugger")
void detach()