org.apache.camel.component.aws.s3

Class S3Endpoint

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.support.DefaultEndpoint

org.apache.camel.support.ScheduledPollEndpoint

org.apache.camel.component.aws.s3.S3Endpoint

All Implemented Interfaces:

AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

@UriEndpoint(firstVersion="2.8.0",
             scheme="aws-s3",
             title="AWS S3 Storage Service",
             syntax="aws-s3://bucketNameOrArn",
             category={CLOUD,FILE})
public class S3Endpoint
extends org.apache.camel.support.ScheduledPollEndpoint

Store and retrie objects from AWS S3 Storage Service.

Field Summary

Fields inherited from class org.apache.camel.support.service.BaseService

BUILDED, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTINGDOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor and Description
S3Endpoint(String uri, org.apache.camel.Component comp, S3Configuration configuration)

Method Summary

Modifier and Type	Method and Description
org.apache.camel.Consumer	createConsumer(org.apache.camel.Processor processor)
org.apache.camel.Exchange	createExchange(org.apache.camel.ExchangePattern pattern, com.amazonaws.services.s3.model.S3Object s3Object)
org.apache.camel.Exchange	createExchange(com.amazonaws.services.s3.model.S3Object s3Object)
org.apache.camel.Producer	createProducer()
void	doStart()
void	doStop()
S3Configuration	getConfiguration()
int	getMaxConnections()
int	getMaxMessagesPerPoll()
com.amazonaws.services.s3.AmazonS3	getS3Client()
void	setConfiguration(S3Configuration configuration)
void	setMaxConnections(int maxConnections) Set the maxConnections parameter in the S3 client configuration
void	setMaxMessagesPerPoll(int maxMessagesPerPoll) Gets the maximum number of messages as a limit to poll at each polling.
void	setS3Client(com.amazonaws.services.s3.AmazonS3 s3Client)

Methods inherited from class org.apache.camel.support.ScheduledPollEndpoint

configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

Methods inherited from class org.apache.camel.support.DefaultEndpoint

configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, createPollingConsumer, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBasicPropertyBinding, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isSingleton, isSynchronous, setBasicPropertyBinding, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.service.BaseService

build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Endpoint

getEndpointBaseUri, isSingletonProducer

Methods inherited from interface org.apache.camel.Service

build, close, init, start, stop

Methods inherited from interface org.apache.camel.CamelContextAware

trySetCamelContext

Methods inherited from interface org.apache.camel.StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface org.apache.camel.SuspendableService

isSuspended, resume, suspend

Methods inherited from interface org.apache.camel.ShutdownableService

shutdown

Constructor Detail

S3Endpoint

public S3Endpoint(String uri,
                  org.apache.camel.Component comp,
                  S3Configuration configuration)

Method Detail

createConsumer

public org.apache.camel.Consumer createConsumer(org.apache.camel.Processor processor)
                                         throws Exception

Throws:

Exception

createProducer

public org.apache.camel.Producer createProducer()
                                         throws Exception

Throws:

Exception

doStart

public void doStart()
             throws Exception

Overrides:

doStart in class org.apache.camel.support.ScheduledPollEndpoint

Throws:

Exception

doStop

public void doStop()
            throws Exception

Overrides:

doStop in class org.apache.camel.support.ScheduledPollEndpoint

Throws:

Exception

createExchange

public org.apache.camel.Exchange createExchange(com.amazonaws.services.s3.model.S3Object s3Object)

createExchange

public org.apache.camel.Exchange createExchange(org.apache.camel.ExchangePattern pattern,
                                                com.amazonaws.services.s3.model.S3Object s3Object)

getConfiguration

public S3Configuration getConfiguration()

setConfiguration

public void setConfiguration(S3Configuration configuration)

setS3Client

public void setS3Client(com.amazonaws.services.s3.AmazonS3 s3Client)

getS3Client

public com.amazonaws.services.s3.AmazonS3 getS3Client()

getMaxMessagesPerPoll

public int getMaxMessagesPerPoll()

setMaxMessagesPerPoll

public void setMaxMessagesPerPoll(int maxMessagesPerPoll)

Gets the maximum number of messages as a limit to poll at each polling.

Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.

getMaxConnections

public int getMaxConnections()

setMaxConnections

public void setMaxConnections(int maxConnections)

Set the maxConnections parameter in the S3 client configuration