|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.camel.support.ServiceSupport org.apache.camel.processor.PollEnricher
public class PollEnricher
A content enricher that enriches input data by first obtaining additional
data from a resource represented by an endpoint producer
and second by aggregating input data and additional data. Aggregation of
input data and additional data is delegated to an AggregationStrategy
object.
PollingConsumer
to obtain the additional data as opposed to Enricher
that uses a Producer
.
Enricher
Field Summary |
---|
Fields inherited from class org.apache.camel.support.ServiceSupport |
---|
shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending |
Constructor Summary | |
---|---|
PollEnricher(AggregationStrategy aggregationStrategy,
PollingConsumer consumer,
long timeout)
Creates a new PollEnricher . |
|
PollEnricher(AggregationStrategy aggregationStrategy,
PollingConsumer consumer,
long timeout,
Boolean pollMultiple)
Creates a new PollEnricher . |
|
PollEnricher(PollingConsumer consumer)
Creates a new PollEnricher . |
Method Summary | |
---|---|
protected void |
doStart()
Implementations override this method to support customized start/stop. |
protected void |
doStop()
Implementations override this method to support customized start/stop. |
protected void |
preCheckPoll(Exchange exchange)
Strategy to pre check polling. |
void |
process(Exchange exchange)
Enriches the input data ( exchange ) by first obtaining
additional data from an endpoint represented by an endpoint
producer and second by aggregating input data and additional
data. |
void |
setAggregationStrategy(AggregationStrategy aggregationStrategy)
Sets the aggregation strategy for this poll enricher. |
void |
setDefaultAggregationStrategy()
Sets the default aggregation strategy for this poll enricher. |
void |
setPollMultiple(Boolean value)
|
void |
setTimeout(long timeout)
Sets the timeout to use when polling. |
String |
toString()
|
Methods inherited from class org.apache.camel.support.ServiceSupport |
---|
doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspended, isSuspending, resume, shutdown, start, stop, suspend |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PollEnricher(PollingConsumer consumer)
PollEnricher
. The default aggregation strategy is to
copy the additional data obtained from the enricher's resource over the
input data. When using the copy aggregation strategy the enricher
degenerates to a normal transformer.
consumer
- consumer to resource endpoint.public PollEnricher(AggregationStrategy aggregationStrategy, PollingConsumer consumer, long timeout)
PollEnricher
.
aggregationStrategy
- aggregation strategy to aggregate input data and additional data.consumer
- consumer to resource endpoint.timeout
- timeout in millispublic PollEnricher(AggregationStrategy aggregationStrategy, PollingConsumer consumer, long timeout, Boolean pollMultiple)
PollEnricher
.
aggregationStrategy
- aggregation strategy to aggregate input data and additional data.consumer
- consumer to resource endpoint.timeout
- timeout in millispollMultiple
- enabled building a List of multiple exchangesMethod Detail |
---|
public void setAggregationStrategy(AggregationStrategy aggregationStrategy)
aggregationStrategy
- the aggregationStrategy to setpublic void setDefaultAggregationStrategy()
public void setTimeout(long timeout)
timeout
- timeout in millis.public void setPollMultiple(Boolean value)
public void process(Exchange exchange) throws Exception
exchange
) by first obtaining
additional data from an endpoint represented by an endpoint
producer
and second by aggregating input data and additional
data. Aggregation of input data and additional data is delegated to an
AggregationStrategy
object set at construction time. If the
message exchange with the resource endpoint fails then no aggregation
will be done and the failed exchange content is copied over to the
original message exchange.
process
in interface Processor
exchange
- input data.
Exception
- if an internal processing error has occurred.protected void preCheckPoll(Exchange exchange) throws Exception
exchange
- the current exchange
Exception
public String toString()
toString
in class Object
protected void doStart() throws Exception
ServiceSupport
ServiceSupport.doStop()
for more details.
doStart
in class ServiceSupport
Exception
ServiceSupport.doStop()
protected void doStop() throws Exception
ServiceSupport
ServiceSupport.doStop()
method when
the service is being stopped. This method will also be invoked
if the service is still in uninitialized state (eg has not
been started). The method is always called to allow the service
to do custom logic when the service is being stopped, such as when
CamelContext
is shutting down.
doStop
in class ServiceSupport
Exception
ServiceSupport.doStart()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |