com.messagegears.sdk.aws

Class MessageGearsAwsClient

java.lang.Object

com.messagegears.sdk.aws.MessageGearsAwsClient

public class MessageGearsAwsClient
extends java.lang.Object

Utility class to allow for easy AWS integration. This class allows to easily be uploaded and deleted from S3, as well as managing SQS queue creation and management. Amazon integration is only necessary if consuming from the activity feed or storing bulk recipient lists on S3. Bulk recipient lists can be stored on any web server as long as they are accessible from either http or https.

Author:

tjones

Constructor Summary

Constructors

Constructor and Description
MessageGearsAwsClient(MessageGearsAwsProperties properties) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	compressFile(java.io.File file) Utility method to compress a given file.
java.lang.String	createQueue(java.lang.String queueName) Utility function to create an Amazon SQS queue for use by the MessageGears platform.
void	deleteS3File(java.lang.String bucketName, java.lang.String key) Utility function to delete a file from the user's S3 Account.
void	deleteSqsMessage(com.amazonaws.services.sqs.model.DeleteMessageRequest request) Utility function to delete a message from the user's SQS Queue.
void	putS3File(java.io.InputStream inputStream, java.lang.String bucketName, java.lang.String key) Utility method to upload a given @InputStream to Amazon S3 in in the user's bucket.
com.amazonaws.services.sqs.model.ReceiveMessageResult	receiveMessage(com.amazonaws.services.sqs.model.ReceiveMessageRequest request) Utility function to pull a message from a given SQS Queue (specified in the request).

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageGearsAwsClient

public MessageGearsAwsClient(MessageGearsAwsProperties properties)

Constructor

Parameters:

properties - The @MessageGearsAwsProperties containing the user credentials.

Method Detail

compressFile

public java.io.File compressFile(java.io.File file)
                          throws java.io.IOException

Utility method to compress a given file. A new file is created using the zip algorithm.

Parameters:

file - The file to be compressed using the zip algorithm.

Returns:

A new file created by removing the ".xml" portion of the file name, and replacing it with ".zip".

Throws:

java.io.IOException - In the event that a file is not found, or cannot be created.

putS3File

public void putS3File(java.io.InputStream inputStream,
             java.lang.String bucketName,
             java.lang.String key)

Utility method to upload a given @InputStream to Amazon S3 in in the user's bucket.

Parameters:

inputStream - The @InputStream to upload.

bucketName - The Amazon S3 bucket name to upload to.

key - The key to use to identify the file (filename).

deleteS3File

public void deleteS3File(java.lang.String bucketName,
                java.lang.String key)

Utility function to delete a file from the user's S3 Account.

Parameters:

bucketName - The bucket name containing the file to be deleted.

key - The key identifying the file to be deleted.

createQueue

public java.lang.String createQueue(java.lang.String queueName)

Utility function to create an Amazon SQS queue for use by the MessageGears platform.

Parameters:

queueName - A @String containing the queue name to create.

Returns:

A @String containing the url to the newly created queue.

receiveMessage

public com.amazonaws.services.sqs.model.ReceiveMessageResult receiveMessage(com.amazonaws.services.sqs.model.ReceiveMessageRequest request)

Utility function to pull a message from a given SQS Queue (specified in the request).

Parameters:

request - A @ReceiveMessageRequest specifying which queue to pull from.

Returns:

A @ReceiveMessageResult containing a message if available.

deleteSqsMessage

public void deleteSqsMessage(com.amazonaws.services.sqs.model.DeleteMessageRequest request)

Utility function to delete a message from the user's SQS Queue.

Parameters:

request - The @DeleteMessageRequest to process.