com.amazonaws.mobile.config

Class AWSConfiguration

java.lang.Object

com.amazonaws.mobile.config.AWSConfiguration

public class AWSConfiguration
extends java.lang.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, java.lang.String configName) Construct an AWSConfiguration object
AWSConfiguration(org.json.JSONObject jsonObject) Construct an AWSConfiguration object based on the JSONObject passed in.
AWSConfiguration(org.json.JSONObject jsonObject, java.lang.String configName) Construct an AWSConfiguration object based on the JSONObject passed in.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfiguration()
java.lang.String	getUserAgent()
java.lang.String	getUserAgentOverride() The user agent is sometimes combined with other strings.
org.json.JSONObject	optJsonObject(java.lang.String key) This method will search for the name provided in the json and unwrap the configuration specified by setConfiguration(String).
void	setConfiguration(java.lang.String configurationName) Change the settings that are being read in.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AWSConfiguration

public AWSConfiguration(org.json.JSONObject jsonObject)

Construct an AWSConfiguration object based on the JSONObject passed in.

Parameters:

jsonObject - contains the configuration information

AWSConfiguration

public AWSConfiguration(org.json.JSONObject jsonObject,
                        java.lang.String configName)

Construct an AWSConfiguration object based on the JSONObject passed in.

Parameters:

jsonObject - contains the configuration information

configName - name of the configuration, "Default" or something else like "Backup"

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,
                        java.lang.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(java.lang.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 java.lang.String getUserAgent()

Returns:

The user agent specified in the configuration file.

getUserAgentOverride

public java.lang.String getUserAgentOverride()

The user agent is sometimes combined with other strings. If this property is set, it instructs the client to only use this as the full user agent string.

Returns:

The user agent override specified in the configuration file.

setConfiguration

public void setConfiguration(java.lang.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 java.lang.String getConfiguration()

Returns:

the configuration This is "Default" by default.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object