{"id":24872,"date":"2015-08-04T11:10:59","date_gmt":"2015-08-04T05:40:59","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=24872"},"modified":"2015-08-04T11:38:34","modified_gmt":"2015-08-04T06:08:34","slug":"integrating-amazon-s3-in-grails-application","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/integrating-amazon-s3-in-grails-application\/","title":{"rendered":"Integrating Amazon S3 in Grails Application"},"content":{"rendered":"

Recently in my project, we needed to store documents on some cloud based storage. So we choose Amazon S3<\/a> as it is secure and has proper backup mechanism and enough data centres so that we have minimum latency to access the server. Amazon has provided a great API available in different languages and we can use their Java API in our Grails application<\/a><\/p>\n

In this blog we will see how to integrate the Amazon JAR in your Grails application and use different operations like upload\/download\/delete file to\/from S3 in some simple steps.<\/p>\n

Step 1<\/em><\/strong> : First you need to have an account on Amazon so that you can consume their services. You will get access_token and secret_key of your owning account which is used for authentication to consume Amazon services through any API call. These credentials should be very secure and should not be exposed to end user. Save credentials into some file let’s say “AWSCredentials.properties” and file content should be something like :<\/p>\n

[groovy]
\n\/\/ File: AWSCredentials.properties
\naccessKey=abcdefghij1234012345678
\nsecretKey=8667f7f66f6fdf+F\/jfj987389784
\n[\/groovy]<\/p>\n

Step 2\u00a0<\/em><\/strong>: Add a line in the “dependency” block for fetching the AWS SDK<\/p>\n

[groovy]<\/p>\n

dependencies {
\n\t…
\n\tcompile ‘com.amazonaws:aws-java-sdk-s3:1.10.8’
\n\t…
\n}
\n[\/groovy]<\/p>\n

Step 3\u00a0<\/em><\/strong>: After you’ve added a dependency, create an “S3Client” and authenticate it with given credentials :<\/p>\n

[groovy]
\nFile file = grailsApplication.mainContext.getResource(‘WEB-INF\/AWSCredential.properties’).file
\nFileInputStream fileInputStream = new FileInputStream(file)
\nAmazonS3 s3Client = new AmazonS3Client(new PropertiesCredentials(fileInputStream))
\n[\/groovy]<\/p>\n

… or register a bean named “s3Client” usable throughout the application as follows:<\/p>\n

[groovy]<\/p>\n

\/\/ resources.groovy
\nFile file = grailsApplication.mainContext.getResource(‘WEB-INF\/AWSCredentials.properties’).file
\nFileInputStream fileInputStream = new FileInputStream(file)<\/p>\n

s3Client(AmazonS3Client, new PropertiesCredentials(fileInputStream)) {}<\/p>\n

[\/groovy]<\/p>\n

So far so good. Once we’ve created a new “S3Client”, its simply a matter of calling the requisite API methods to perform the respective actions. Let’s try out a few operations.<\/p>\n

Create a new bucket:<\/h3>\n

[groovy]
\ns3Client.createBucket(new CreateBucketRequest(‘My-Bucket’));
\n[\/groovy]<\/p>\n

Upload a new file on a given bucket:<\/h3>\n

[groovy]
\nString key = UUID.randomUUID().toString() \/\/ Key should be unique for each upload.
\nFile file = new File(‘MyPath’) \/\/ You can upload any type of file.
\nPutObjectRequest putObjectRequest = new PutObjectRequest(‘My-Bucket’, key, file)
\nputObjectRequest.withCannedAcl(CannedAccessControlList.AuthenticatedRead)) \/\/ secure everything
\ns3Client.putObject(putObjectRequest)
\n[\/groovy]<\/p>\n

Fetch a file from a bucket:<\/h3>\n

[groovy]
\nGetObjectRequest getObjectRequest = new GetObjectRequest(‘My-Bucket’, key)
\ns3Client().getObject(getObjectRequest)
\n[\/groovy]<\/p>\n

Delete a file from a bucket<\/h3>\n

[groovy]
\nDeleteObjectRequest deleteObjectRequest = new DeleteObjectRequest(‘My-Bucket’, key)
\ns3Client().deleteObject(deleteObjectRequest);
\n[\/groovy]<\/p>\n

Remember “key” is the unique identifier for your every single file upload , so this needs to be stored for future reference.<\/p>\n

I hope this blog was helpfull to integrate Amazon S3 within your grails application.<\/p>\n","protected":false},"excerpt":{"rendered":"

Recently in my project, we needed to store documents on some cloud based storage. So we choose Amazon S3 as it is secure and has proper backup mechanism and enough data centres so that we have minimum latency to access the server. Amazon has provided a great API available in different languages and we can […]<\/p>\n","protected":false},"author":72,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":14},"categories":[1174,7,446],"tags":[2117,2116],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/24872"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/72"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=24872"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/24872\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=24872"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=24872"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=24872"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}