|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Endpoint
An endpoint implements the Message Endpoint pattern and represents an endpoint that can send and receive message exchanges
Exchange
,
Message
Method Summary | |
---|---|
void |
configureProperties(Map<String,Object> options)
Configure properties on this endpoint. |
Consumer |
createConsumer(Processor processor)
Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor |
Exchange |
createExchange()
Create a new exchange for communicating with this endpoint |
Exchange |
createExchange(Exchange exchange)
Deprecated. will be removed in Camel 3.0 |
Exchange |
createExchange(ExchangePattern pattern)
Create a new exchange for communicating with this endpoint with the specified ExchangePattern such as whether its going
to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange |
PollingConsumer |
createPollingConsumer()
Creates a new Polling Consumer so that the caller can poll message exchanges from the consumer using PollingConsumer.receive() ,
PollingConsumer.receiveNoWait() or
PollingConsumer.receive(long) whenever it is ready to do so
rather than using the Event
Based Consumer returned by createConsumer(Processor) |
Producer |
createProducer()
Creates a new producer which is used send messages into the endpoint |
CamelContext |
getCamelContext()
Returns the context which created the endpoint |
EndpointConfiguration |
getEndpointConfiguration()
Returns the object representation of the endpoint configuration |
String |
getEndpointKey()
Returns a string key of this endpoint. |
String |
getEndpointUri()
Returns the string representation of the endpoint URI |
boolean |
isLenientProperties()
Should all properties be known or does the endpoint allow unknown options? lenient = false means that the endpoint should validate that all given options is known and configured properly. |
void |
setCamelContext(CamelContext context)
Sets the camel context. |
Methods inherited from interface org.apache.camel.IsSingleton |
---|
isSingleton |
Methods inherited from interface org.apache.camel.Service |
---|
start, stop |
Method Detail |
---|
String getEndpointUri()
EndpointConfiguration getEndpointConfiguration()
String getEndpointKey()
LifecycleStrategy
when registering endpoint.
This allows to register different instances of endpoints with the same key.
For JMX mbeans this allows us to use the same JMX Mbean for all endpoints that are logical
the same but have different parameters. For instance the http endpoint.
Exchange createExchange()
Exchange createExchange(ExchangePattern pattern)
ExchangePattern
such as whether its going
to be an ExchangePattern.InOnly
or ExchangePattern.InOut
exchange
pattern
- the message exchange pattern for the exchange
@Deprecated Exchange createExchange(Exchange exchange)
exchange
- given exchange to use for pre-populate
CamelContext getCamelContext()
Producer createProducer() throws Exception
Exception
- can be thrownConsumer createConsumer(Processor processor) throws Exception
processor
- the given processor
Exception
- can be thrownPollingConsumer createPollingConsumer() throws Exception
PollingConsumer.receive()
,
PollingConsumer.receiveNoWait()
or
PollingConsumer.receive(long)
whenever it is ready to do so
rather than using the Event
Based Consumer returned by createConsumer(Processor)
Exception
- if the pull consumer could not be createdvoid configureProperties(Map<String,Object> options)
options
- the options (properties)void setCamelContext(CamelContext context)
context
- the camel contextboolean isLenientProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |