org.apache.camel.management

Class JmxNotificationEventNotifier

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.support.EventNotifierSupport

org.apache.camel.management.JmxNotificationEventNotifier

All Implemented Interfaces:

JmxNotificationBroadcasterAware, Service, ShutdownableService, EventNotifier, StatefulService, SuspendableService

public class JmxNotificationEventNotifier
extends EventNotifierSupport
implements JmxNotificationBroadcasterAware

A JMX based EventNotifier which broadcasts JMX Notifications.

Version:

Field Summary

Fields inherited from class org.apache.camel.support.EventNotifierSupport

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
JmxNotificationEventNotifier()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
String	getSource()
boolean	isEnabled(EventObject event) Checks whether notification for the given event is enabled.
void	notify(EventObject event) Notifies the given event
void	setNotificationBroadcaster(NotificationBroadcasterSupport broadcaster) Sets to use a custom broadcaster
void	setSource(String source) Sets the source to be used when broadcasting events.

Methods inherited from class org.apache.camel.support.EventNotifierSupport

isIgnoreCamelContextEvents, isIgnoreExchangeCompletedEvent, isIgnoreExchangeCreatedEvent, isIgnoreExchangeEvents, isIgnoreExchangeFailedEvents, isIgnoreExchangeRedeliveryEvents, isIgnoreExchangeSendingEvents, isIgnoreExchangeSentEvents, isIgnoreRouteEvents, isIgnoreServiceEvents, setIgnoreCamelContextEvents, setIgnoreExchangeCompletedEvent, setIgnoreExchangeCreatedEvent, setIgnoreExchangeEvents, setIgnoreExchangeFailedEvents, setIgnoreExchangeRedeliveryEvents, setIgnoreExchangeSendingEvents, setIgnoreExchangeSentEvents, setIgnoreRouteEvents, setIgnoreServiceEvents

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JmxNotificationEventNotifier

public JmxNotificationEventNotifier()

Method Detail

setNotificationBroadcaster

public void setNotificationBroadcaster(NotificationBroadcasterSupport broadcaster)

Description copied from interface: JmxNotificationBroadcasterAware

Sets to use a custom broadcaster

Specified by:

setNotificationBroadcaster in interface JmxNotificationBroadcasterAware

Parameters:

broadcaster - the custom broadcaster

notify

public void notify(EventObject event)
            throws Exception

Description copied from interface: EventNotifier

Notifies the given event

Specified by:

notify in interface EventNotifier

Parameters:

event - the event

Throws:

Exception - can be thrown if notification failed

isEnabled

public boolean isEnabled(EventObject event)

Description copied from interface: EventNotifier

Checks whether notification for the given event is enabled.

If disabled the event will not be sent and silently ignored instead.

Specified by:

isEnabled in interface EventNotifier

Parameters:

event - the event

Returns:

true if the event should be sent, false to silently ignore it

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class EventNotifierSupport

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class EventNotifierSupport

Throws:

Exception

See Also:

ServiceSupport.doStart()

getSource

public String getSource()

setSource

public void setSource(String source)

Sets the source to be used when broadcasting events. The source is just a readable identifier which helps the receiver see where the event is coming from. You can assign a value such a server or application name etc.

By default Camel will be used as source.

Parameters:

source - the source