org.apache.camel.spi
Interface Breakpoint

All Known Implementing Classes:
BreakpointSupport

public interface Breakpoint

Breakpoint are used by the Debugger API.

This allows you to register Breakpoints to the Debugger and have those breakpoints activated when their Conditions match.

If any exceptions is thrown from the callback methods then the Debugger will catch and log those at WARN level and continue. This ensures Camel can continue to route the message without having breakpoints causing issues.

Version:
See Also:
Debugger, Condition

Nested Class Summary
static class Breakpoint.State
           
 
Method Summary
 void activate()
          Activates this breakpoint
 void afterProcess(Exchange exchange, Processor processor, ProcessorDefinition definition, long timeTaken)
          Callback invoked when the breakpoint was hit and the Exchange has been processed (after).
 void beforeProcess(Exchange exchange, Processor processor, ProcessorDefinition definition)
          Callback invoked when the breakpoint was hit and the Exchange is about to be processed (before).
 Breakpoint.State getState()
          Gets the state of this break
 void onEvent(Exchange exchange, EventObject event, ProcessorDefinition definition)
          Callback invoked when the breakpoint was hit and any of the Exchange events occurred.
 void suspend()
          Suspend this breakpoint
 

Method Detail

getState

Breakpoint.State getState()
Gets the state of this break

Returns:
the state

suspend

void suspend()
Suspend this breakpoint


activate

void activate()
Activates this breakpoint


beforeProcess

void beforeProcess(Exchange exchange,
                   Processor processor,
                   ProcessorDefinition definition)
Callback invoked when the breakpoint was hit and the Exchange is about to be processed (before).

Parameters:
exchange - the Exchange
processor - the Processor about to be processed
definition - the ProcessorDefinition definition of the processor

afterProcess

void afterProcess(Exchange exchange,
                  Processor processor,
                  ProcessorDefinition definition,
                  long timeTaken)
Callback invoked when the breakpoint was hit and the Exchange has been processed (after).

Parameters:
exchange - the Exchange
processor - the Processor which was processed
definition - the ProcessorDefinition definition of the processor
timeTaken - time in millis it took to process the Exchange - time spend in breakpoint callbacks may affect this time

onEvent

void onEvent(Exchange exchange,
             EventObject event,
             ProcessorDefinition definition)
Callback invoked when the breakpoint was hit and any of the Exchange events occurred.

Parameters:
exchange - the Exchange
event - the event (instance of AbstractExchangeEvent
definition - the ProcessorDefinition definition of the last processor executed, may be null if not possible to resolve from tracing
See Also:
AbstractExchangeEvent


Apache CAMEL