com.netflix.config.sources

Class S3ConfigurationSource

java.lang.Object

com.netflix.config.sources.S3ConfigurationSource

All Implemented Interfaces:

com.netflix.config.PolledConfigurationSource

public class S3ConfigurationSource
extends java.lang.Object
implements com.netflix.config.PolledConfigurationSource

A polled configuration source backed by a file on Amazon S3. When successfully retrieved, the file is decoded using Properties.load(InputStream) - just like URLConfigurationSource. Poll requests throw exceptions in line with AmazonS3.getObject(GetObjectRequest) and Properties.load(InputStream) for the obvious reasons (file not found, bad credentials, no network connection, malformed file...)

Constructor Summary

Constructors

Constructor and Description
S3ConfigurationSource(com.amazonaws.services.s3.AmazonS3 client, java.lang.String bucketName, java.lang.String key) Create the instance with the provided AmazonS3, bucket and key.
S3ConfigurationSource(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, java.lang.String bucketName, java.lang.String key) Create the instance with the specified credentials, bucket and key.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	inputStreamToMap(java.io.InputStream is)
com.netflix.config.PollResult	poll(boolean initial, java.lang.Object checkPoint)

Methods inherited from class java.lang.Object

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

Constructor Detail

S3ConfigurationSource

public S3ConfigurationSource(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                             java.lang.String bucketName,
                             java.lang.String key)

Create the instance with the specified credentials, bucket and key. Uses the default AmazonS3Client.

Parameters:

credentialsProvider -

bucketName - The S3 bucket containing the configuration file.

key - The key of the file within that bucket.

S3ConfigurationSource

public S3ConfigurationSource(com.amazonaws.services.s3.AmazonS3 client,
                             java.lang.String bucketName,
                             java.lang.String key)

Create the instance with the provided AmazonS3, bucket and key. Suitable for injecting a custom client for testing, messing around with endpoints etc.

Parameters:

client - to be used to retrieve the object.

bucketName - The S3 bucket containing the configuration file.

key - The key of the file within that bucket.

Method Detail

poll

public com.netflix.config.PollResult poll(boolean initial,
                                          java.lang.Object checkPoint)
                                   throws java.io.IOException,
                                          com.amazonaws.AmazonServiceException

Specified by:

poll in interface com.netflix.config.PolledConfigurationSource

Throws:

java.io.IOException

com.amazonaws.AmazonServiceException

inputStreamToMap

protected java.util.Map<java.lang.String,java.lang.Object> inputStreamToMap(java.io.InputStream is)
                                                                     throws java.io.IOException

Throws:

java.io.IOException