First Commit

Author: Eric Dallo and Gabriel Lima Gomes

.gitignore

@@ -0,0 +1,10 @@
+.classpath
+.settings
+.project
+.class
+.bin
+.lock
+.gradle
+target/
+build/
+bin/

README.md

@@ -0,0 +1,6 @@
+# Spring S3 Property Loader #
+
+S3 Property Loader has the aim of allowing loading of Spring property files from S3 bucket, in order to guarantee stateless machine configuration.
+
+Spring PropertyConfigurer replaces standard PropertyConfigurer to load property files from AWS S3 bucket. S3 path could be specified directly into spring beans.
+

build.gradle

@@ -0,0 +1,69 @@
+apply plugin: 'java'
+apply plugin: 'eclipse'
+apply plugin: 'application'
+apply plugin: 'net.researchgate.release'
+apply plugin: 'maven-publish'
+apply plugin: 'maven'
+apply plugin: 'signing'
+
+compileJava.options.encoding = 'UTF-8'
+
+group = 'com.spring.loader'
+archivesBaseName = 's3-property-loader'
+
+buildscript {
+    repositories {
+        mavenLocal()
+        mavenCentral()
+    }
+
+    dependencies {
+        classpath 'net.researchgate:gradle-release:2.3.5'
+    }
+}
+
+eclipse {
+    classpath {
+        downloadJavadoc = true
+        downloadSources = true
+    }
+}
+
+release {
+  failOnCommitNeeded = false
+  failOnPublishNeeded = true
+  failOnSnapshotDependencies = true
+  failOnUnversionedFiles = true
+  failOnUpdateNeeded = true
+  revertOnFail = true
+}
+
+afterReleaseBuild.dependsOn publish
+
+repositories {
+    mavenCentral()
+    mavenLocal()
+}
+
+dependencies {
+    compile "org.springframework:spring-core:3.0.5.RELEASE"
+    compile "org.springframework:spring-beans:3.0.5.RELEASE"
+    compile "org.springframework.cloud:spring-cloud-aws-autoconfigure:1.0.4.RELEASE"
+
+    testCompile "junit:junit:4.12"
+    testCompile "org.mockito:mockito-core:1.10.19"
+    testCompile "org.assertj:assertj-core:1.0.0"
+}
+
+task sourcesJar(type: Jar) {
+    from sourceSets.main.allSource
+    classifier = 'sources'
+}
+
+artifacts {
+    archives jar
+
+    archives sourcesJar
+}
+
+mainClassName = ''

gradle.properties

@@ -0,0 +1 @@
+version=1.0.1-SNAPSHOT

src/main/java/com/spring/loader/S3Path.java

@@ -0,0 +1,21 @@
+package com.spring.loader;
+
+class S3Path {
+	
+	private final String bucketName;
+	private final String keyName;
+	
+	public S3Path(String bucketName, String keyName) {
+		this.bucketName = bucketName;
+		this.keyName = keyName;
+	}
+
+	public String getBucketName() {
+		return bucketName;
+	}
+
+	public String getKeyName() {
+		return keyName;
+	}
+	
+}

src/main/java/com/spring/loader/S3PropertyPlaceholderConfigurer.java

@@ -0,0 +1,67 @@
+package com.spring.loader;
+
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Properties;
+
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
+import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer;
+import org.springframework.core.io.Resource;
+
+public class S3PropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer {
+
+	private S3ResourceLoader resourceLoader;
+	private String[] s3Locations = new String[0];
+	private Resource[] conventionalResources = new Resource[0];
+	private boolean ignoreS3resourceNotFound = false;
+
+	public S3PropertyPlaceholderConfigurer(S3ResourceLoader resourceLoader) {
+		this.resourceLoader = resourceLoader;
+	}
+
+	@Override
+	public void setLocations(Resource... locations) {
+		this.conventionalResources = locations;
+	}
+
+	@SuppressWarnings("deprecation")
+	public void setS3Locations(String[] s3Locations) {
+		this.s3Locations = new String[s3Locations.length];
+		for (int i = 0; i < s3Locations.length; i++) {
+			this.s3Locations[i] = parseStringValue(s3Locations[i], new Properties(), new HashSet<>());
+		}
+
+	}
+
+	@Override
+	public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
+		injectS3Resources();
+		super.postProcessBeanFactory(beanFactory);
+	}
+
+	private void injectS3Resources() {
+
+		int total = conventionalResources.length + s3Locations.length;
+
+		if (total > 0) {
+			List<Resource> allResources = new ArrayList<>();
+			for (String s3Location : s3Locations) {
+				try {
+					allResources.add(resourceLoader.getResource(s3Location));
+				} catch (S3ResourceException exp) {
+					if (!ignoreS3resourceNotFound) {
+						throw exp;
+					}
+				}
+			}
+			for (Resource conventionalResource : conventionalResources) {
+				allResources.add(conventionalResource);
+			}
+
+			super.setLocations(allResources.toArray(new Resource[0]));
+		}
+
+	}
+}

src/main/java/com/spring/loader/S3ResourceException.java

@@ -0,0 +1,13 @@
+package com.spring.loader;
+
+public class S3ResourceException extends RuntimeException {
+	private static final long serialVersionUID = 8310280589629514933L;
+
+	public S3ResourceException(String msg) {
+		super(msg);
+	}
+
+	public S3ResourceException(String msg, Throwable cause) {
+		super(msg, cause);
+	}
+}

src/main/java/com/spring/loader/S3ResourceLoader.java

@@ -0,0 +1,65 @@
+package com.spring.loader;
+
+import org.springframework.core.io.InputStreamResource;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+
+import com.amazonaws.auth.AWSCredentials;
+import com.amazonaws.services.s3.AmazonS3;
+import com.amazonaws.services.s3.AmazonS3Client;
+import com.amazonaws.services.s3.model.S3Object;
+
+public class S3ResourceLoader implements ResourceLoader {
+
+	private static final String S3_PROTOCOL_PREFIX = "s3://";
+
+	private AmazonS3 s3;
+
+	public S3ResourceLoader(AWSCredentials credentials) {
+		this(new AmazonS3Client(credentials));
+	}
+	
+	public S3ResourceLoader(AmazonS3 s3) {
+		this.s3 = s3;
+	}
+
+	@Override
+	public ClassLoader getClassLoader() {
+		return this.getClassLoader();
+	}
+
+	@Override
+	public Resource getResource(String location) {
+		try {
+			S3Path s3Path = parseS3Path(location);
+			S3Object s3Object = s3.getObject(s3Path.getBucketName(), s3Path.getKeyName());
+			return new InputStreamResource(s3Object.getObjectContent(), location);
+
+		} catch (Exception e) {
+			throw new S3ResourceException("Could not load resource from " + location, e);
+		}
+	}
+
+	private static S3Path parseS3Path(String location) {
+
+		String path = getLocationPath(location);
+		String bucketName = path.substring(0, path.indexOf("/"));
+		String keyName = path.substring(path.indexOf("/") + 1);
+
+		return new S3Path(bucketName, keyName);
+	}
+
+	private static String getLocationPath(String location) {
+
+		if (location == null || "".equals(location.trim())) {
+			throw new S3ResourceException("Location cannot be empty or null");
+		}
+
+		if (location.startsWith(S3_PROTOCOL_PREFIX)) {
+			return location.substring(S3_PROTOCOL_PREFIX.length(), location.length());
+		}
+
+		throw new S3ResourceException(location + " does not begin with '" + S3_PROTOCOL_PREFIX + "'");
+	}
+
+}