Package org.apache.camel.spi

Interface BrowsableEndpoint

All Superinterfaces:

AutoCloseable, ComponentAware, Endpoint, IsSingleton, Service

public interface BrowsableEndpoint
extends Endpoint

An optional interface an Endpoint may choose to implement which allows it to expose a way of browsing the exchanges available.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	BrowsableEndpoint.BrowseStatus	A quick status of the browse queue

Method Summary

Modifier and Type	Method	Description
int	getBrowseLimit()	Maximum number of messages to browse by default.
default BrowsableEndpoint.BrowseStatus	getBrowseStatus(int limit)	Returns a quick browse status
List<Exchange>	getExchanges()	Return the exchanges available on this endpoint
default List<Exchange>	getExchanges(int limit, Predicate filter)	Return the exchanges available on this endpoint, allowing to filter the result in the specific component.
void	setBrowseLimit(int browseLimit)	Maximum number of messages to browse by default.

Methods inherited from interface org.apache.camel.ComponentAware

getComponent, getComponent, setComponent

Methods inherited from interface org.apache.camel.Endpoint

configureExchange, configureProperties, createAsyncProducer, createConsumer, createExchange, createExchange, createPollingConsumer, createProducer, getCamelContext, getEndpointBaseUri, getEndpointKey, getEndpointUri, getExchangePattern, isLenientProperties, isRemote, isSingletonProducer, setCamelContext

Methods inherited from interface org.apache.camel.IsSingleton

isSingleton

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Method Details

getBrowseLimit

int getBrowseLimit()

Maximum number of messages to browse by default.

setBrowseLimit

void setBrowseLimit(int browseLimit)

Maximum number of messages to browse by default.

getBrowseStatus

default BrowsableEndpoint.BrowseStatus getBrowseStatus(int limit)

Returns a quick browse status

Parameters:

limit - to limit the result to a maximum. Use 0 for default limit.

Returns:

the status

getExchanges

List<Exchange> getExchanges()

Return the exchanges available on this endpoint

Returns:

the exchanges on this endpoint

getExchanges

default List<Exchange> getExchanges(int limit,
 Predicate filter)

Return the exchanges available on this endpoint, allowing to filter the result in the specific component.

Parameters:

limit - to limit the result to a maximum. Use 0 for default limit.

filter - filter to filter among the messages to include.

Returns:

the exchanges on this endpoint