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

Interface ManagedBacklogTracerMBean

public interface ManagedBacklogTracerMBean

Method Summary

Modifier and Type	Method	Description
void	clear()
List<org.apache.camel.spi.BacklogTracerEventMessage>	dumpAllTracedMessages()
String	dumpAllTracedMessagesAsJSon()
String	dumpAllTracedMessagesAsXml()
List<org.apache.camel.spi.BacklogTracerEventMessage>	dumpTracedMessages(String nodeOrRouteId)
String	dumpTracedMessagesAsJSon(String nodeOrRouteId)
String	dumpTracedMessagesAsXml(String nodeOrRouteId)
int	getBacklogSize()
int	getBodyMaxChars()
String	getCamelId()
String	getCamelManagementName()
long	getQueueSize()
long	getTraceCounter()
String	getTraceFilter()
String	getTracePattern()
boolean	isBodyIncludeFiles()
boolean	isBodyIncludeStreams()
boolean	isEnabled()
boolean	isIncludeExchangeProperties()
boolean	isIncludeExchangeVariables()
boolean	isRemoveOnDump()
boolean	isStandby()
boolean	isTraceRests()
boolean	isTraceTemplates()
void	resetTraceCounter()
void	setBacklogSize(int backlogSize)
void	setBodyIncludeFiles(boolean bodyIncludeFiles)
void	setBodyIncludeStreams(boolean bodyIncludeStreams)
void	setBodyMaxChars(int bodyMaxChars)
void	setEnabled(boolean enabled)
void	setIncludeExchangeProperties(boolean includeExchangeProperties)
void	setIncludeExchangeVariables(boolean includeExchangeVariables)
void	setRemoveOnDump(boolean removeOnDump)
void	setTraceFilter(String predicate)
void	setTracePattern(String pattern)

Method Details

getCamelId

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

getCamelManagementName

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

isStandby

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

isEnabled

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

setEnabled

@ManagedAttribute(description="Is tracing enabled")
void setEnabled(boolean enabled)

getBacklogSize

@ManagedAttribute(description="Number of maximum traced messages in total to keep in the backlog (FIFO queue)")
int getBacklogSize()

setBacklogSize

@ManagedAttribute(description="Number of maximum traced messages in total to keep in the backlog (FIFO queue)")
void setBacklogSize(int backlogSize)

isRemoveOnDump

@ManagedAttribute(description="Whether to remove traced message from backlog when dumping trace messages")
boolean isRemoveOnDump()

setRemoveOnDump

@ManagedAttribute(description="Whether to remove traced message from backlog when dumping trace messages")
void setRemoveOnDump(boolean removeOnDump)

setTracePattern

@ManagedAttribute(description="To filter tracing by nodes (pattern)")
void setTracePattern(String pattern)

getTracePattern

@ManagedAttribute(description="To filter tracing by nodes (pattern)")
String getTracePattern()

setTraceFilter

@ManagedAttribute(description="To filter tracing by predicate (uses simple language by default)")
void setTraceFilter(String predicate)

getTraceFilter

@ManagedAttribute(description="To filter tracing by predicate (uses simple language by default)")
String getTraceFilter()

getTraceCounter

@ManagedAttribute(description="Number of total traced messages")
long getTraceCounter()

resetTraceCounter

@ManagedOperation(description="Resets the trace counter")
void resetTraceCounter()

getQueueSize

@ManagedAttribute(description="Number of traced messages in the backlog")
long getQueueSize()

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)

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)

isTraceRests

@ManagedAttribute(description="Whether tracing routes created from Rest DSL.")
boolean isTraceRests()

isTraceTemplates

@ManagedAttribute(description="Whether tracing routes created from route templates or kamelets.")
boolean isTraceTemplates()

dumpTracedMessages

@ManagedOperation(description="Dumps the traced messages for the given node or route")
List<org.apache.camel.spi.BacklogTracerEventMessage> dumpTracedMessages(String nodeOrRouteId)

dumpTracedMessagesAsXml

@ManagedOperation(description="Dumps the traced messages for the given node or route in XML format")
String dumpTracedMessagesAsXml(String nodeOrRouteId)

dumpTracedMessagesAsJSon

@ManagedOperation(description="Dumps the traced messages for the given node or route in JSon format")
String dumpTracedMessagesAsJSon(String nodeOrRouteId)

dumpAllTracedMessages

@ManagedOperation(description="Dumps all the traced messages")
List<org.apache.camel.spi.BacklogTracerEventMessage> dumpAllTracedMessages()

dumpAllTracedMessagesAsXml

@ManagedOperation(description="Dumps all the traced messages in XML format")
String dumpAllTracedMessagesAsXml()

dumpAllTracedMessagesAsJSon

@ManagedOperation(description="Dumps all the traced messages in JSon format")
String dumpAllTracedMessagesAsJSon()

clear

@ManagedOperation(description="Clears the backlog")
void clear()