org.apache.camel.impl

Class DefaultRuntimeEndpointRegistry

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.support.EventNotifierSupport

org.apache.camel.impl.DefaultRuntimeEndpointRegistry

All Implemented Interfaces:

CamelContextAware, Service, ShutdownableService, EventNotifier, RuntimeEndpointRegistry, StatefulService, StaticService, SuspendableService

public class DefaultRuntimeEndpointRegistry
extends EventNotifierSupport
implements CamelContextAware, RuntimeEndpointRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.spi.RuntimeEndpointRegistry

RuntimeEndpointRegistry.Statistic

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears the registry
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
List<String>	getAllEndpoints(boolean includeInputs) Gets all the endpoint uris captured during runtime routing that are in-use of the routes.
CamelContext	getCamelContext() Get the CamelContext
List<String>	getEndpointsPerRoute(String routeId, boolean includeInputs) Gets all the endpoint uris captured from the given route during runtime routing that are in-use of the routes.
List<RuntimeEndpointRegistry.Statistic>	getEndpointStatistics() Gets details about all the endpoint captured from the given route during runtime routing that are in-use of the routes.
int	getLimit() Maximum number of endpoints to keep in the cache per route.
boolean	isEnabled() Whether gathering runtime usage is enabled or not.
boolean	isEnabled(EventObject event) Checks whether notification for the given event is enabled.
void	notify(EventObject event) Notifies the given event
void	reset() Reset the statistic counters
void	setCamelContext(CamelContext camelContext) Injects the CamelContext
void	setEnabled(boolean enabled) Sets whether gathering runtime usage is enabled or not.
void	setLimit(int limit) Sets the maximum number of endpoints to keep in the cache per route.
int	size() Number of endpoints currently in the cache.

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

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

DefaultRuntimeEndpointRegistry

public DefaultRuntimeEndpointRegistry()

Method Detail

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

isEnabled

public boolean isEnabled()

Description copied from interface: RuntimeEndpointRegistry

Whether gathering runtime usage is enabled or not.

Specified by:

isEnabled in interface RuntimeEndpointRegistry

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: RuntimeEndpointRegistry

Sets whether gathering runtime usage is enabled or not.

Specified by:

setEnabled in interface RuntimeEndpointRegistry

getAllEndpoints

public List<String> getAllEndpoints(boolean includeInputs)

Description copied from interface: RuntimeEndpointRegistry

Gets all the endpoint uris captured during runtime routing that are in-use of the routes.

Specified by:

getAllEndpoints in interface RuntimeEndpointRegistry

Parameters:

includeInputs - whether to include route inputs

getEndpointsPerRoute

public List<String> getEndpointsPerRoute(String routeId,
                                boolean includeInputs)

Description copied from interface: RuntimeEndpointRegistry

Gets all the endpoint uris captured from the given route during runtime routing that are in-use of the routes.

Specified by:

getEndpointsPerRoute in interface RuntimeEndpointRegistry

Parameters:

routeId - the route id

includeInputs - whether to include route inputs

getEndpointStatistics

public List<RuntimeEndpointRegistry.Statistic> getEndpointStatistics()

Description copied from interface: RuntimeEndpointRegistry

Gets details about all the endpoint captured from the given route during runtime routing that are in-use of the routes.

Specified by:

getEndpointStatistics in interface RuntimeEndpointRegistry

getLimit

public int getLimit()

Description copied from interface: RuntimeEndpointRegistry

Maximum number of endpoints to keep in the cache per route.

The default value is 1000

Specified by:

getLimit in interface RuntimeEndpointRegistry

setLimit

public void setLimit(int limit)

Description copied from interface: RuntimeEndpointRegistry

Sets the maximum number of endpoints to keep in the cache per route.

Specified by:

setLimit in interface RuntimeEndpointRegistry

clear

public void clear()

Description copied from interface: RuntimeEndpointRegistry

Clears the registry

Specified by:

clear in interface RuntimeEndpointRegistry

reset

public void reset()

Description copied from interface: RuntimeEndpointRegistry

Reset the statistic counters

Specified by:

reset in interface RuntimeEndpointRegistry

size

public int size()

Description copied from interface: RuntimeEndpointRegistry

Number of endpoints currently in the cache.

Specified by:

size in interface RuntimeEndpointRegistry

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

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