Package com.adaptris.aws2.s3.retry

Class S3RetryStore

java.lang.Object

com.adaptris.aws2.s3.retry.S3RetryStore

All Implemented Interfaces:

ComponentLifecycle, ComponentLifecycleExtension, RetryStore

@ComponentProfile(summary="Supporting implementation for using S3 as your failed message store",
                  tag="retry,amazon,s3",
                  since="4.3.0",
                  recommended=AmazonS3Connection.class)
public class S3RetryStore
extends Object
implements RetryStore

Since:

4.3.0

In the adapter configuration file this class is aliased as amazon-s3-retry-store which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	METADATA_FILE_NAME
protected static final String	PAYLOAD_FILE_NAME
protected static final String	STACKTRACE_FILENAME

Constructor Summary

Constructors

Constructor	Description
S3RetryStore()

Method Summary

Modifier and Type	Method	Description
void	acknowledge(String acknowledgeId)
AdaptrisMessage	buildForRetry(String msgId, Map<String,String> metadata, AdaptrisMessageFactory factory)
void	close()
boolean	delete(String msgId)
void	deleteAcknowledged()
String	getBucket()
@NonNull AdaptrisConnection	getConnection()	Set the connection to use to connect to S3.
Map<String,String>	getMetadata(String msgId)
String	getPrefix()
String	getStackTrace(String msgId)
void	init()
void	makeConnection(AdaptrisConnection connection)
List<AdaptrisMessage>	obtainExpiredMessages()
List<AdaptrisMessage>	obtainMessagesToRetry()
void	prepare()
Iterable<RemoteBlob>	report(boolean includeErrorMessage)
void	setBucket(String bucket)
void	setConnection(@NonNull AdaptrisConnection connection)	Set the connection to use to connect to S3.
void	setPrefix(String prefix)
void	start()
void	stop()
void	updateRetryCount(String messageId)
S3RetryStore	withBucket(String s)
S3RetryStore	withConnection(AdaptrisConnection c)
S3RetryStore	withPrefix(String s)
void	write(AdaptrisMessage msg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adaptris.core.http.jetty.retry.RetryStore

buildForRetry, buildForRetry, getStacktraceFirstLine

Field Details

PAYLOAD_FILE_NAME

protected static final String PAYLOAD_FILE_NAME

See Also:

• Constant Field Values

METADATA_FILE_NAME

protected static final String METADATA_FILE_NAME

See Also:

• Constant Field Values

STACKTRACE_FILENAME

protected static final String STACKTRACE_FILENAME

See Also:

• Constant Field Values

Constructor Details

S3RetryStore

public S3RetryStore()

Method Details

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Specified by:

prepare in interface RetryStore

Throws:

CoreException

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

close

public void close()

Specified by:

close in interface ComponentLifecycle

withConnection

public S3RetryStore withConnection(AdaptrisConnection c)

withPrefix

public S3RetryStore withPrefix(String s)

withBucket

public S3RetryStore withBucket(String s)

report

public Iterable<RemoteBlob> report(boolean includeErrorMessage)
                            throws InterlokException

Specified by:

report in interface RetryStore

Throws:

InterlokException

delete

public boolean delete(String msgId)
               throws InterlokException

Specified by:

delete in interface RetryStore

Throws:

InterlokException

write

public void write(AdaptrisMessage msg)
           throws InterlokException

Specified by:

write in interface RetryStore

Throws:

InterlokException

buildForRetry

public AdaptrisMessage buildForRetry(String msgId,
 Map<String,String> metadata,
 AdaptrisMessageFactory factory)
                              throws InterlokException

Specified by:

buildForRetry in interface RetryStore

Throws:

InterlokException

getMetadata

public Map<String,String> getMetadata(String msgId)
                               throws InterlokException

Specified by:

getMetadata in interface RetryStore

Throws:

InterlokException

getStackTrace

public String getStackTrace(String msgId)
                     throws InterlokException

Specified by:

getStackTrace in interface RetryStore

Throws:

InterlokException

acknowledge

public void acknowledge(String acknowledgeId)
                 throws InterlokException

Specified by:

acknowledge in interface RetryStore

Throws:

InterlokException

deleteAcknowledged

public void deleteAcknowledged()
                        throws InterlokException

Specified by:

deleteAcknowledged in interface RetryStore

Throws:

InterlokException

obtainExpiredMessages

public List<AdaptrisMessage> obtainExpiredMessages()
                                            throws InterlokException

Specified by:

obtainExpiredMessages in interface RetryStore

Throws:

InterlokException

updateRetryCount

public void updateRetryCount(String messageId)
                      throws InterlokException

Specified by:

updateRetryCount in interface RetryStore

Throws:

InterlokException

obtainMessagesToRetry

public List<AdaptrisMessage> obtainMessagesToRetry()
                                            throws InterlokException

Specified by:

obtainMessagesToRetry in interface RetryStore

Throws:

InterlokException

makeConnection

public void makeConnection(AdaptrisConnection connection)

Specified by:

makeConnection in interface RetryStore

getConnection

@NonNull
public @NonNull AdaptrisConnection getConnection()

Set the connection to use to connect to S3.

setConnection

public void setConnection(@NonNull
 @NonNull AdaptrisConnection connection)

Set the connection to use to connect to S3.

getBucket

public String getBucket()

setBucket

public void setBucket(String bucket)

getPrefix

public String getPrefix()

setPrefix

public void setPrefix(String prefix)