org.apache.camel.component.browse
Class BrowseEndpoint

java.lang.Object
  org.apache.camel.support.ServiceSupport
      org.apache.camel.impl.DefaultEndpoint
          org.apache.camel.component.browse.BrowseEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, BrowsableEndpoint, HasId, StatefulService, SuspendableService

public class BrowseEndpoint
extends DefaultEndpoint
implements BrowsableEndpoint, Service

An endpoint which maintains a List of Exchange instances which can be useful for tooling, debugging and visualising routes.

Version:

Field Summary

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

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

Constructor Summary

BrowseEndpoint()

BrowseEndpoint(String uri, Component component)

Method Summary

Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
protected List<Exchange>	createExchangeList()
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
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<Exchange>	getExchanges() Return the exchanges available on this endpoint
boolean	isSingleton() Whether this class supports being singleton or not.
protected void	onExchange(Exchange exchange) Invoked on a message exchange being sent by a producer

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExchangePattern, getId, hashCode, isLenientProperties, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, setSynchronous, toString

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

configureProperties, createExchange, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointConfiguration, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

BrowseEndpoint

public BrowseEndpoint()

BrowseEndpoint

public BrowseEndpoint(String uri,
                      Component component)

Method Detail

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Returns:

true to be a single shared instance, false to create new instances.

getExchanges

public List<Exchange> getExchanges()

Description copied from interface: BrowsableEndpoint

Return the exchanges available on this endpoint

Specified by:

getExchanges in interface BrowsableEndpoint

Returns:

the exchanges on this endpoint

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

createExchangeList

protected List<Exchange> createExchangeList()

onExchange

protected void onExchange(Exchange exchange)
                   throws Exception

Invoked on a message exchange being sent by a producer

Parameters:

exchange - the exchange

Throws:

Exception - is thrown if failed to process the exchange

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 DefaultEndpoint

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 DefaultEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()