com.amazonaws.mobile.config

Class AWSConfiguration

java.lang.Object

com.amazonaws.mobile.config.AWSConfiguration

public class AWSConfiguration
extends Object

A container for the JSONObject representation of SDK configuration. Reads the res/raw/awsconfiguration.json file in your project by default. This can be specified in the constructor through the resource id, if you wish to read a different resource as your configuration source.

Constructor Summary

Constructors

Constructor and Description
AWSConfiguration(android.content.Context context) Constructs an AWSConfiguration object
AWSConfiguration(android.content.Context context, int configResourceId) Constructs an AWSConfiguration object
AWSConfiguration(android.content.Context context, int configResourceId, String configName) Construct an AWSConfiguration object

Method Summary

Modifier and Type	Method and Description
String	getConfiguration()
String	getUserAgent()
org.json.JSONObject	optJsonObject(String key) This method will search for the name provided in the json and unwrap the configuration specified by setConfiguration(String).
void	setConfiguration(String configurationName) Change the settings that are being read in.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSConfiguration

public AWSConfiguration(android.content.Context context)

Constructs an AWSConfiguration object

Parameters:

context - application context, used to retrieve awsconfiguration.json from resources

AWSConfiguration

public AWSConfiguration(android.content.Context context,
                        int configResourceId)

Constructs an AWSConfiguration object

Parameters:

context - application context, used to retrieve the resource specified by configResourceId

configResourceId - resource id of the json file to be read

AWSConfiguration

public AWSConfiguration(android.content.Context context,
                        int configResourceId,
                        String configName)

Construct an AWSConfiguration object

Parameters:

context - application context, used to retrieve the resource specified by configResourceId

configResourceId - resource id of the json file to be read

configName - instructs the reader of this configuration to pick the specified configName

Method Detail

optJsonObject

public org.json.JSONObject optJsonObject(String key)

This method will search for the name provided in the json and unwrap the configuration specified by setConfiguration(String). Example: { "S3TransferUtility": { "Default": { "Bucket": "waterBucket", "Region": "us-west-2" } } } When name is "S3TransferUtility" and setConfiguration is "Default", The value return is: { "Bucket": "waterBucket", "Region": "us-west-2" } Certain keys do not have a configuration (i.e. "Default") and when this happens the value for the key is directly returned.

Parameters:

key - used to search for in JSON map

Returns:

an immutable copy of the value mapped by name if it exists and is a JSONObject, or null otherwise.

getUserAgent

public String getUserAgent()

Returns:

The user agent specified in the configuration file.

setConfiguration

public void setConfiguration(String configurationName)

Change the settings that are being read in. This is "Default" by default.

Parameters:

configurationName - the key used to differentiate between configuration settings

getConfiguration

public String getConfiguration()

Returns:

the configuration This is "Default" by default.

toString

public String toString()

Overrides:

toString in class Object