|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.camel.impl.DefaultEndpoint
public abstract class DefaultEndpoint
A default endpoint useful for implementation inheritance
| Constructor Summary | |
|---|---|
protected |
DefaultEndpoint()
|
protected |
DefaultEndpoint(String endpointUri)
|
protected |
DefaultEndpoint(String endpointUri,
CamelContext camelContext)
|
protected |
DefaultEndpoint(String endpointUri,
Component component)
|
| Method Summary | |
|---|---|
void |
configureProperties(Map options)
Configure properties on this endpoint. |
Exchange |
convertTo(Class<Exchange> type,
Exchange exchange)
Converts the given exchange to the specified exchange type |
protected String |
createEndpointUri()
A factory method to lazily create the endpointUri if none is specified |
Exchange |
createExchange()
Create a new exchange for communicating with this endpoint |
Exchange |
createExchange(Exchange exchange)
Creates a new exchange for communicating with this exchange using the given exchange to pre-populate the values of the headers and messages |
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 Endpoint.createConsumer(Processor) |
protected ScheduledExecutorService |
createScheduledExecutorService()
|
boolean |
equals(Object object)
|
CamelContext |
getCamelContext()
Returns the context which created the endpoint |
Component |
getComponent()
|
String |
getEndpointKey()
Returns a string key of this endpoint. |
String |
getEndpointUri()
Returns the string representation of the endpoint URI |
ExchangePattern |
getExchangePattern()
|
Class<Exchange> |
getExchangeType()
Returns the type of the exchange which is generated by this component |
ExecutorService |
getExecutorService()
|
ScheduledExecutorService |
getScheduledExecutorService()
|
int |
hashCode()
|
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 camelContext)
Injects the CamelContext |
protected void |
setEndpointUri(String endpointUri)
|
void |
setEndpointUriIfNotSpecified(String value)
Sets the endpointUri if it has not been specified yet via some kind of dependency injection mechanism. |
void |
setExchangePattern(ExchangePattern exchangePattern)
|
void |
setExecutorService(ExecutorService executorService)
|
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.camel.Endpoint |
|---|
createConsumer, createProducer |
| Methods inherited from interface org.apache.camel.IsSingleton |
|---|
isSingleton |
| Constructor Detail |
|---|
protected DefaultEndpoint(String endpointUri,
Component component)
protected DefaultEndpoint(String endpointUri,
CamelContext camelContext)
protected DefaultEndpoint(String endpointUri)
protected DefaultEndpoint()
| Method Detail |
|---|
public int hashCode()
hashCode in class Objectpublic boolean equals(Object object)
equals in class Objectpublic String toString()
toString in class Objectpublic String getEndpointUri()
Endpoint
getEndpointUri in interface Endpointpublic String getEndpointKey()
EndpointLifecycleStrategy 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.
getEndpointKey in interface Endpointpublic CamelContext getCamelContext()
Endpoint
getCamelContext in interface Endpointpublic Component getComponent()
public void setCamelContext(CamelContext camelContext)
CamelContextAwareCamelContext
setCamelContext in interface CamelContextAwaresetCamelContext in interface EndpointcamelContext - the Camel contextpublic ExecutorService getExecutorService()
public ScheduledExecutorService getScheduledExecutorService()
public void setExecutorService(ExecutorService executorService)
public PollingConsumer createPollingConsumer()
throws Exception
EndpointPollingConsumer.receive(),
PollingConsumer.receiveNoWait() or
PollingConsumer.receive(long) whenever it is ready to do so
rather than using the Event
Based Consumer returned by Endpoint.createConsumer(Processor)
createPollingConsumer in interface EndpointException - if the pull consumer could not be created
public Exchange convertTo(Class<Exchange> type,
Exchange exchange)
public Exchange createExchange(Exchange exchange)
Endpoint
createExchange in interface Endpointexchange - given exchange to use for pre-populate
public Class<Exchange> getExchangeType()
public Exchange createExchange()
Endpoint
createExchange in interface Endpointpublic Exchange createExchange(ExchangePattern pattern)
EndpointExchangePattern such as whether its going
to be an ExchangePattern.InOnly or ExchangePattern.InOut exchange
createExchange in interface Endpointpattern - the message exchange pattern for the exchange
public ExchangePattern getExchangePattern()
public void setExchangePattern(ExchangePattern exchangePattern)
protected ScheduledExecutorService createScheduledExecutorService()
public void configureProperties(Map options)
Endpoint
configureProperties in interface Endpointoptions - the options (properties)protected String createEndpointUri()
public void setEndpointUriIfNotSpecified(String value)
protected void setEndpointUri(String endpointUri)
public boolean isLenientProperties()
Endpoint
isLenientProperties in interface Endpoint
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||