org.apache.camel.management
Class PublishEventNotifier

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.support.EventNotifierSupport
          org.apache.camel.management.PublishEventNotifier

All Implemented Interfaces:

CamelContextAware, Service, ShutdownableService, EventNotifier, StatefulService, SuspendableService

public class PublishEventNotifier
extends EventNotifierSupport
implements CamelContextAware

A EventNotifier which publishes the EventObject to some Endpoint.

This notifier is only enabled when CamelContext is started. This avoids problems when sending notifications during start/shutdown of CamelContext which causes problems by sending those events to Camel routes by this notifier.

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

PublishEventNotifier()

Method Summary

protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
CamelContext	getCamelContext() Get the CamelContext
Endpoint	getEndpoint()
String	getEndpointUri()
boolean	isEnabled(EventObject event) Checks whether notification for the given event is enabled.
void	notify(EventObject event) Notifies the given event
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setEndpoint(Endpoint endpoint)
void	setEndpointUri(String endpointUri)
String	toString()

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, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

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

Constructor Detail

PublishEventNotifier

public PublishEventNotifier()

Method Detail

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

getCamelContext

public CamelContext getCamelContext()

Description copied from interface: CamelContextAware

Get the CamelContext

Specified by:

getCamelContext in interface CamelContextAware

Returns:

camelContext the Camel context

setCamelContext

public void setCamelContext(CamelContext camelContext)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

camelContext - the Camel context

getEndpoint

public Endpoint getEndpoint()

setEndpoint

public void setEndpoint(Endpoint endpoint)

getEndpointUri

public String getEndpointUri()

setEndpointUri

public void setEndpointUri(String endpointUri)

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()

toString

public String toString()

Overrides:

toString in class Object