org.apache.camel.component.browse

Class BrowseEndpoint

java.lang.Object

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.component.browse.BrowseEndpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.BrowsableEndpoint, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="1.3.0",
             scheme="browse",
             title="Browse",
             syntax="browse:name",
             label="core,monitoring")
public class BrowseEndpoint
extends org.apache.camel.support.DefaultEndpoint
implements org.apache.camel.spi.BrowsableEndpoint

The browse component is used for viewing the messages received on endpoints that supports BrowsableEndpoint. This can be useful for testing, visualisation tools or debugging. The exchanges sent to the endpoint are all available to be browsed.

Field Summary

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

BUILDED, FAILED, INITIALIZED, lock, log, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
BrowseEndpoint()
BrowseEndpoint(String uri, org.apache.camel.Component component)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
protected List<org.apache.camel.Exchange>	createExchangeList()
org.apache.camel.Producer	createProducer()
protected void	doStart()
protected void	doStop()
List<org.apache.camel.Exchange>	getExchanges()
String	getName()
protected void	onExchange(org.apache.camel.Exchange exchange) Invoked on a message exchange being sent by a producer
void	setName(String name)

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

configureConsumer, configurePollingConsumer, configureProperties, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

build, doBuild, doResume, doShutdown, doSuspend, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, 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, createAsyncProducer, createExchange, createExchange, createPollingConsumer, getCamelContext, getEndpointKey, getEndpointUri, isLenientProperties, setCamelContext

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Constructor Detail

BrowseEndpoint

public BrowseEndpoint()

BrowseEndpoint

public BrowseEndpoint(String uri,
                      org.apache.camel.Component component)

Method Detail

getExchanges

public List<org.apache.camel.Exchange> getExchanges()

Specified by:

getExchanges in interface org.apache.camel.spi.BrowsableEndpoint

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Specified by:

createProducer in interface org.apache.camel.Endpoint

Throws:

Exception

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Specified by:

createConsumer in interface org.apache.camel.Endpoint

Throws:

Exception

getName

public String getName()

setName

public void setName(String name)

createExchangeList

protected List<org.apache.camel.Exchange> createExchangeList()

onExchange

protected void onExchange(org.apache.camel.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

Overrides:

doStart in class org.apache.camel.support.DefaultEndpoint

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class org.apache.camel.support.DefaultEndpoint

Throws:

Exception