org.apache.camel.spi
Interface ManagementStrategy

All Superinterfaces:
org.fusesource.commons.management.ManagementStrategy, Service

public interface ManagementStrategy
extends org.fusesource.commons.management.ManagementStrategy, Service

Strategy for management.

This is totally pluggable allowing to use a custom or 3rd party management implementation with Camel.

Version:
See Also:
EventNotifier, EventFactory, ManagementNamingStrategy, ManagementAgent

Method Summary
 void addEventNotifier(EventNotifier eventNotifier)
          Adds the event notifier to use.
 EventFactory getEventFactory()
          Gets the event factory
 List<EventNotifier> getEventNotifiers()
          Gets the event notifiers.
 ManagementAgent getManagementAgent()
          Gets the management agent
 ManagementNamingStrategy getManagementNamingStrategy()
          Gets the naming strategy to use
 ManagementStatisticsLevel getStatisticsLevel()
          Gets the statistics level
 boolean isOnlyManageProcessorWithCustomId()
          Checks whether only to manage processors if they have been configured with a custom id
 boolean manageProcessor(ProcessorDefinition<?> definition)
          Filter whether the processor should be managed or not.
 void onlyManageProcessorWithCustomId(boolean flag)
          Sets the whether only manage processors if they have been configured with a custom id

Default is false.

 boolean removeEventNotifier(EventNotifier eventNotifier)
          Removes the event notifier
 void setEventFactory(EventFactory eventFactory)
          Sets the event factory to use
 void setEventNotifiers(List<EventNotifier> eventNotifier)
          Sets the list of event notifier to use.
 void setManagementAgent(ManagementAgent managementAgent)
          Sets the management agent to use
 void setManagementNamingStrategy(ManagementNamingStrategy strategy)
          Sets the naming strategy to use
 void setStatisticsLevel(ManagementStatisticsLevel level)
          Sets the statistics level

Default is ManagementStatisticsLevel.All

 
Methods inherited from interface org.fusesource.commons.management.ManagementStrategy
createStatistic, getManagedObjectName, isManaged, manageNamedObject, manageObject, notify, unmanageNamedObject, unmanageObject
 
Methods inherited from interface org.apache.camel.Service
start, stop
 

Method Detail

getEventNotifiers

List<EventNotifier> getEventNotifiers()
Gets the event notifiers.

Returns:
event notifiers

setEventNotifiers

void setEventNotifiers(List<EventNotifier> eventNotifier)
Sets the list of event notifier to use.

Parameters:
eventNotifier - list of event notifiers

addEventNotifier

void addEventNotifier(EventNotifier eventNotifier)
Adds the event notifier to use.

Ensure the event notifier has been started if its a Service, as otherwise it would not be used.

Parameters:
eventNotifier - event notifier

removeEventNotifier

boolean removeEventNotifier(EventNotifier eventNotifier)
Removes the event notifier

Parameters:
eventNotifier - event notifier to remove
Returns:
true if removed, false if already removed

getEventFactory

EventFactory getEventFactory()
Gets the event factory

Returns:
event factory

setEventFactory

void setEventFactory(EventFactory eventFactory)
Sets the event factory to use

Parameters:
eventFactory - event factory

getManagementNamingStrategy

ManagementNamingStrategy getManagementNamingStrategy()
Gets the naming strategy to use

Returns:
naming strategy

setManagementNamingStrategy

void setManagementNamingStrategy(ManagementNamingStrategy strategy)
Sets the naming strategy to use

Parameters:
strategy - naming strategy

getManagementAgent

ManagementAgent getManagementAgent()
Gets the management agent

Returns:
management agent

setManagementAgent

void setManagementAgent(ManagementAgent managementAgent)
Sets the management agent to use

Parameters:
managementAgent - management agent

manageProcessor

boolean manageProcessor(ProcessorDefinition<?> definition)
Filter whether the processor should be managed or not.

Is used to filter out unwanted processors to avoid managing at too fine grained level.

Parameters:
definition - definition of the processor
Returns:
true to manage it

onlyManageProcessorWithCustomId

void onlyManageProcessorWithCustomId(boolean flag)
Sets the whether only manage processors if they have been configured with a custom id

Default is false.

Parameters:
flag - true will only manage if custom id was set.

isOnlyManageProcessorWithCustomId

boolean isOnlyManageProcessorWithCustomId()
Checks whether only to manage processors if they have been configured with a custom id

Returns:
true or false

setStatisticsLevel

void setStatisticsLevel(ManagementStatisticsLevel level)
Sets the statistics level

Default is ManagementStatisticsLevel.All

Parameters:
level - the new level

getStatisticsLevel

ManagementStatisticsLevel getStatisticsLevel()
Gets the statistics level

Returns:
the level


Apache CAMEL