Uses of Interface
org.apache.camel.Endpoint
Package
Description
The core Camel API.
Service Provider Interfaces used by the Camel runtime which are plugin strategies.
-
Uses of Endpoint in org.apache.camel
Modifier and TypeInterfaceDescriptioninterface
Marks theEndpoint
as an endpoint from an API based component.interface
Marks theEndpoint
as support asynchronous non-blocking routing in its consumer and producer.interface
An interface to represent anEndpoint
which are delegated.Modifier and TypeMethodDescription<T extends Endpoint>
TCamelContext.getEndpoint
(String name, Class<T> endpointType) Resolves the given name to anEndpoint
of the specified type.<T extends Endpoint>
TEndpointConsumerResolver.resolve
(CamelContext context, Class<T> endpointType) Resolves this object as an endpoint.<T extends Endpoint>
TEndpointProducerResolver.resolve
(CamelContext context, Class<T> endpointType) Resolves this object as an endpoint.Modifier and TypeMethodDescriptionCamelContext.addEndpoint
(String uri, Endpoint endpoint) Adds and starts the endpoint to theEndpointRegistry
using the given URI.Component.createEndpoint
(String uri) Attempt to resolve an endpoint for the given URI if the component is capable of handling the URI.Component.createEndpoint
(String uri, Map<String, Object> parameters) Attempt to resolve an endpoint for the given URI if the component is capable of handling the URI.FluentProducerTemplate.getDefaultEndpoint()
Get the default endpoint to use if none is specifiedProducerTemplate.getDefaultEndpoint()
Get the default endpoint to use if none is specifiedCamelContext.getEndpoint
(String uri) Resolves the given name to anEndpoint
of the specified type.CamelContext.getEndpoint
(String uri, Map<String, Object> parameters) Resolves the given name to anEndpoint
of the specified type.DelegateEndpoint.getEndpoint()
Gets the delegatedEndpoint
.EndpointAware.getEndpoint()
Gets the endpoint associated with an object.ExtendedCamelContext.getEndpoint
(NormalizedEndpointUri uri) Resolves the given name to anEndpoint
of the specified type.ExtendedCamelContext.getEndpoint
(NormalizedEndpointUri uri, Map<String, Object> parameters) Resolves the given name to anEndpoint
of the specified type.ProxyInstantiationException.getEndpoint()
Route.getEndpoint()
Gets the input endpoint for this route.Exchange.getFromEndpoint()
Returns the endpoint which originated this message exchange if a consumer on an endpoint created the message exchange, otherwise his property will be null.ExchangeExtension.getFromEndpoint()
Returns the endpoint which originated this message exchange.ExtendedCamelContext.getPrototypeEndpoint
(String uri) Resolves the given name to anEndpoint
of the specified type (scope is prototype).ExtendedCamelContext.getPrototypeEndpoint
(NormalizedEndpointUri uri) Resolves the given name to anEndpoint
of the specified type (scope is prototype).CamelContext.hasEndpoint
(String uri) Is the given endpoint already registered in theEndpointRegistry
ExtendedCamelContext.hasEndpoint
(NormalizedEndpointUri uri) Is the given endpoint already registered in theEndpointRegistry
EndpointConsumerResolver.resolve
(CamelContext context) Resolves this object as an endpoint.EndpointProducerResolver.resolve
(CamelContext context) Resolves this object as an endpoint.Modifier and TypeMethodDescriptionCamelContext.getEndpoints()
Returns a read-onlyCollection
of all of the endpoints from theEndpointRegistry
CamelContext.removeEndpoints
(String pattern) Removes all endpoints with the given URI from theEndpointRegistry
.Modifier and TypeMethodDescriptionCamelContext.addEndpoint
(String uri, Endpoint endpoint) Adds and starts the endpoint to theEndpointRegistry
using the given URI.ProducerTemplate.asyncRequestBody
(Endpoint endpoint, Object body) Sends an asynchronous body to the given endpoint.<T> CompletableFuture
<T> ProducerTemplate.asyncRequestBody
(Endpoint endpoint, Object body, Class<T> type) Sends an asynchronous body to the given endpoint.ProducerTemplate.asyncRequestBodyAndHeader
(Endpoint endpoint, Object body, String header, Object headerValue) Sends an asynchronous body to the given endpoint.<T> CompletableFuture
<T> ProducerTemplate.asyncRequestBodyAndHeader
(Endpoint endpoint, Object body, String header, Object headerValue, Class<T> type) Sends an asynchronous body to the given endpoint.ProducerTemplate.asyncRequestBodyAndHeaders
(Endpoint endpoint, Object body, Map<String, Object> headers) Sends an asynchronous body to the given endpoint.<T> CompletableFuture
<T> ProducerTemplate.asyncRequestBodyAndHeaders
(Endpoint endpoint, Object body, Map<String, Object> headers, Class<T> type) Sends an asynchronous body to the given endpoint.Sends an asynchronous exchange to the given endpoint.Sends an asynchronous exchange to the given endpoint.ProducerTemplate.asyncSendBody
(Endpoint endpoint, Object body) Sends an asynchronous body to the given endpoint.Receives from the endpoint, waiting until there is a response.Receives from the endpoint, waiting until there is a response or the timeout occursConsumerTemplate.receiveBody
(Endpoint endpoint) Receives from the endpoint, waiting until there is a responseConsumerTemplate.receiveBody
(Endpoint endpoint, long timeout) Receives from the endpoint, waiting until there is a response or the timeout occurs<T> T
ConsumerTemplate.receiveBody
(Endpoint endpoint, long timeout, Class<T> type) Receives from the endpoint, waiting until there is a response or the timeout occurs<T> T
ConsumerTemplate.receiveBody
(Endpoint endpoint, Class<T> type) Receives from the endpoint, waiting until there is a responseConsumerTemplate.receiveBodyNoWait
(Endpoint endpoint) Receives from the endpoint, not waiting for a response if non exists.<T> T
ConsumerTemplate.receiveBodyNoWait
(Endpoint endpoint, Class<T> type) Receives from the endpoint, not waiting for a response if non exists.ConsumerTemplate.receiveNoWait
(Endpoint endpoint) Receives from the endpoint, not waiting for a response if non exists.void
CamelContext.removeEndpoint
(Endpoint endpoint) Removes the endpoint from theEndpointRegistry
.Sends an exchange to an endpoint using a supplied processor Uses anExchangePattern.InOut
message exchange pattern.ProducerTemplate.requestBody
(Endpoint endpoint, Object body) Send the body to an endpoint returning any result output body.<T> T
ProducerTemplate.requestBody
(Endpoint endpoint, Object body, Class<T> type) Send the body to an endpoint returning any result output body.ProducerTemplate.requestBodyAndHeader
(Endpoint endpoint, Object body, String header, Object headerValue) Send the body to an endpoint returning any result output body.<T> T
ProducerTemplate.requestBodyAndHeader
(Endpoint endpoint, Object body, String header, Object headerValue, Class<T> type) Send the body to an endpoint returning any result output body.Sends the body to an endpoint with the specified headers and header values.<T> T
ProducerTemplate.requestBodyAndHeaders
(Endpoint endpoint, Object body, Map<String, Object> headers, Class<T> type) Sends the body to an endpoint with the specified headers and header values.Sends the exchange to the given endpoint
ProducerTemplate.send
(Endpoint endpoint, ExchangePattern pattern, Processor processor) Sends an exchange to an endpoint using a supplied processor
ProducerTemplate.send
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor) Sends an exchange to an endpoint using a supplied processor
Sends an exchange to an endpoint using a supplied processor
void
Send the body to an endpoint
ProducerTemplate.sendBody
(Endpoint endpoint, ExchangePattern pattern, Object body) void
ProducerTemplate.sendBodyAndHeader
(Endpoint endpoint, Object body, String header, Object headerValue) Sends the body to an endpoint with a specified header and header value
ProducerTemplate.sendBodyAndHeader
(Endpoint endpoint, ExchangePattern pattern, Object body, String header, Object headerValue) Sends the body to an endpoint with a specified header and header value
void
Sends the body to an endpoint with the specified headers and header values
ProducerTemplate.sendBodyAndHeaders
(Endpoint endpoint, ExchangePattern pattern, Object body, Map<String, Object> headers) Sends the body to an endpoint with the specified headers and header values
void
ProducerTemplate.sendBodyAndProperty
(Endpoint endpoint, Object body, String property, Object propertyValue) Sends the body to an endpoint with a specified property and property value
ProducerTemplate.sendBodyAndProperty
(Endpoint endpoint, ExchangePattern pattern, Object body, String property, Object propertyValue) Sends the body to an endpoint with a specified property and property value
void
FluentProducerTemplate.setDefaultEndpoint
(Endpoint defaultEndpoint) Sets the default endpoint to use if none is specifiedvoid
ProducerTemplate.setDefaultEndpoint
(Endpoint defaultEndpoint) Sets the default endpoint to use if none is specifiedvoid
ExchangeExtension.setFromEndpoint
(Endpoint fromEndpoint) Sets the endpoint which originated this message exchange.Endpoint to send toFluentProducerTemplate.withDefaultEndpoint
(Endpoint endpoint) Sets the default endpointModifierConstructorDescriptionFailedToCreateConsumerException
(Endpoint endpoint, String message) FailedToCreateConsumerException
(Endpoint endpoint, String message, Throwable cause) FailedToCreateConsumerException
(Endpoint endpoint, Throwable cause) FailedToCreateProducerException
(Endpoint endpoint, Throwable cause) ProxyInstantiationException
(Class<?> type, Endpoint endpoint, Throwable cause) -
Uses of Endpoint in org.apache.camel.spi
Modifier and TypeInterfaceDescriptioninterface
An optional interface anEndpoint
may choose to implement which allows it to expose a way of browsing the exchanges available.interface
This is an endpoint when sending to it, is intercepted and is routed in a detour, with the following flow: before, send to original endpoint (can be skipped), after (optional).Modifier and TypeMethodDescriptionInterceptEndpointFactory.createInterceptSendToEndpoint
(CamelContext camelContext, Endpoint endpoint, boolean skip, Processor before, Processor after) Creates an endpoint when intercepting sending to an endpoint (detour).CamelEvent.ExchangeSendingEvent.getEndpoint()
CamelEvent.ExchangeSentEvent.getEndpoint()
InterceptSendToEndpoint.getOriginalEndpoint()
The original endpoint which was intercepted.EndpointStrategy.registerEndpoint
(String uri, Endpoint endpoint) Register the endpoint.Modifier and TypeMethodDescriptionEndpointRegistry.getReadOnlyMap()
Gets a read-only map of the endpoints currently in the registry.EndpointRegistry.getReadOnlyValues()
Gets a read-only collection of the endpoints currently in the registry.Modifier and TypeMethodDescriptionConsumerCache.acquirePollingConsumer
(Endpoint endpoint) Acquires a pooled polling consumer which you must release back again after usage using theConsumerCache.releasePollingConsumer(Endpoint, PollingConsumer)
method.ProducerCache.acquireProducer
(Endpoint endpoint) Acquires a pooled producer which you must release back again after usage using theProducerCache.releaseProducer(org.apache.camel.Endpoint, org.apache.camel.AsyncProducer)
method.ProducerCache.asyncSendExchange
(Endpoint endpoint, ExchangePattern pattern, Processor processor, Processor resultProcessor, Exchange exchange, CompletableFuture<Exchange> future) Asynchronously sends an exchange to an endpoint using a suppliedProcessor
to populate the exchangeboolean
Called when poll is about to beginvoid
Called when poll is completed successfullyGets a newExchange
ProcessorExchangeFactory.create
(Endpoint fromEndpoint, ExchangePattern exchangePattern) Gets a newExchange
EventFactory.createExchangeSendingEvent
(Exchange exchange, Endpoint endpoint) Creates anCamelEvent
when anExchange
is about to be sent to the endpoint (eg before).EventFactory.createExchangeSentEvent
(Exchange exchange, Endpoint endpoint, long timeTaken) Creates anCamelEvent
when anExchange
has completely been sent to the endpoint (eg after).InterceptEndpointFactory.createInterceptSendToEndpoint
(CamelContext camelContext, Endpoint endpoint, boolean skip, Processor before, Processor after) Creates an endpoint when intercepting sending to an endpoint (detour).InternalProcessorFactory.createInterceptSendToEndpointProcessor
(InterceptSendToEndpoint endpoint, Endpoint delegate, AsyncProducer producer, boolean skip) DeferServiceFactory.createProducer
(Endpoint endpoint) Creates theProducer
which is deferred started untilCamelContext
is being started.<T> T
BeanProxyFactory.createProxy
(Endpoint endpoint, boolean binding, Class<T>... interfaceClasses) Creates a proxy bean facaded with the interfaces that when invoked will send the data as a message to a Camel endpoint.RouteFactory.createRoute
(CamelContext camelContext, NamedNode routeDefinition, String routeId, String routeDescription, Endpoint endpoint, Resource resource) Creates the route which should be configured afterwards with more configurations.boolean
ProducerCache.doInAsyncProducer
(Endpoint endpoint, Exchange exchange, AsyncCallback callback, ProducerCache.AsyncProducerCallback producerCallback) Sends an exchange to an endpoint using a supplied callback supporting the asynchronous routing engine.ManagementObjectStrategy.getManagedObjectForEndpoint
(CamelContext context, Endpoint endpoint) ManagementObjectNameStrategy.getObjectNameForEndpoint
(Endpoint endpoint) void
LifecycleStrategy.onEndpointAdd
(Endpoint endpoint) Notification on adding anEndpoint
.void
LifecycleStrategy.onEndpointRemove
(Endpoint endpoint) Notification on removing anEndpoint
.Waits until a message is available and then returns it.Attempts to receive a message exchange, waiting up to the given timeout to expire if a message is not yet available.ConsumerCache.receiveNoWait
(Endpoint endpoint) Attempts to receive a message exchange immediately without waiting and returning null if a message exchange is not available yet.EndpointStrategy.registerEndpoint
(String uri, Endpoint endpoint) Register the endpoint.void
ConsumerCache.releasePollingConsumer
(Endpoint endpoint, PollingConsumer pollingConsumer) Releases an acquired polling consumer back after usage.void
ProducerCache.releaseProducer
(Endpoint endpoint, AsyncProducer producer) Releases an acquired producer back after usage.boolean
PollingConsumerPollStrategy.rollback
(Consumer consumer, Endpoint endpoint, int retryCounter, Exception cause) Called when poll failedSends the exchange to the given endpoint.