com.amazonaws.regions

Class RegionUtils

java.lang.Object

com.amazonaws.regions.RegionUtils

public class RegionUtils
extends Object

Utilities for working with regions.

Constructor Summary

Constructors

Constructor and Description
RegionUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static Region	getRegion(String regionName) Returns the region with the id given, if it exists.
static Region	getRegionByEndpoint(String endpoint) Searches through all known regions to find one with any service at the specified endpoint.
static RegionMetadata	getRegionMetadata() Returns the current set of region metadata for this process, initializing it if it has not yet been explicitly initialized before.
static List<Region>	getRegions() Returns a list of the available AWS regions.
static List<Region>	getRegionsForService(String serviceAbbreviation) Returns a list of the regions that support the service given.
protected static String	getSource() For test purposes.
static void	init() Deprecated. in favor of initialize()
static void	initialize() Initializes the region metadata by loading from the default hierarchy of region metadata locations.
static void	initializeFromFile(File file) Initializes the region metadata singleton from an XML file on disk.
static void	initializeFromResource(Class<?> clazz, String name) Initializes the region metadata singleton from the given resource.
static void	initializeFromResource(ClassLoader classLoader, String name) Initializes the region metadata singleton from the given resource.
static void	initializeFromResource(String name) Initializes the region metadata singleton from an XML file stored as a resource of the classloader used to load the RegionUtils class.
static void	initializeFromURI(URI uri) Loads a set of region metadata by downloading an XML file from the given URI and parsing it.
static void	initializeFromURI(URI uri, ClientConfiguration config) Loads a set of region metadata by downloading an XML file from the given URI and parsing it.
static void	initializeWithMetadata(RegionMetadata metadata) Directly sets the singleton RegionMetadata instance.
static RegionMetadata	loadMetadataFromFile(File file) Loads a set of region metadata from an XML file on disk.
static RegionMetadata	loadMetadataFromInputStream(InputStream stream) Loads a set of region metadata from an arbitrary InputStream containing an XML file.
static RegionMetadata	loadMetadataFromResource(Class<?> clazz, String name) Loads a set of region metadata from an XML file stored as a resource of the classloader used to load the given class.
static RegionMetadata	loadMetadataFromResource(ClassLoader classLoader, String name) Loads a set of region metadata from an XML file stored as a resource of the given classloader.
static RegionMetadata	loadMetadataFromResource(String name) Loads a set of region metadata from an XML file stored as a resource of the classloader used to load the RegionUtils class.
static RegionMetadata	loadMetadataFromURI(URI uri) Loads a set of region metadata by downloading an XML file from the given URI and parsing it.
static RegionMetadata	loadMetadataFromURI(URI uri, ClientConfiguration config) Loads a set of region metadata by downloading an XML file from the given URI and parsing it.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegionUtils

public RegionUtils()

Method Detail

getSource

protected static String getSource()

For test purposes.

Returns:

the source from which the region metadata singleton was loaded

getRegionMetadata

public static RegionMetadata getRegionMetadata()

Returns the current set of region metadata for this process, initializing it if it has not yet been explicitly initialized before.

Returns:

the current set of region metadata

getRegions

public static List<Region> getRegions()

Returns a list of the available AWS regions.

getRegionsForService

public static List<Region> getRegionsForService(String serviceAbbreviation)

Returns a list of the regions that support the service given.

See Also:

ServiceAbbreviations

getRegion

public static Region getRegion(String regionName)

Returns the region with the id given, if it exists. Otherwise, returns null.

getRegionByEndpoint

public static Region getRegionByEndpoint(String endpoint)

Searches through all known regions to find one with any service at the specified endpoint. If no region is found with a service at that endpoint, an exception is thrown.

Parameters:

endpoint - The endpoint for any service residing in the desired region.

Returns:

The region containing any service running at the specified endpoint, otherwise an exception is thrown if no region is found with a service at the specified endpoint.

Throws:

IllegalArgumentException - If the given URL is malformed, or if the one of the service URLs on record is malformed.

loadMetadataFromURI

public static RegionMetadata loadMetadataFromURI(URI uri)
                                          throws IOException

Loads a set of region metadata by downloading an XML file from the given URI and parsing it.

Parameters:

uri - the uri of the XML file to parse

Returns:

the parsed region metadata

Throws:

IOException - on error fetching or parsing the XML file

loadMetadataFromURI

public static RegionMetadata loadMetadataFromURI(URI uri,
                                 ClientConfiguration config)
                                          throws IOException

Loads a set of region metadata by downloading an XML file from the given URI and parsing it.

Parameters:

uri - the uri of the XML file to parse

config - configuration for the HTTP client to use to fetch the file

Returns:

the parsed region metadata

Throws:

IOException - on error fetching or parsing the XML file

loadMetadataFromFile

public static RegionMetadata loadMetadataFromFile(File file)
                                           throws IOException

Loads a set of region metadata from an XML file on disk.

Parameters:

file - the file to load from

Returns:

the loaded region metadata

Throws:

IOException - on error opening or reading from the file

loadMetadataFromResource

public static RegionMetadata loadMetadataFromResource(String name)
                                               throws IOException

Loads a set of region metadata from an XML file stored as a resource of the classloader used to load the RegionUtils class.

Parameters:

name - the path of the resource, relative to the RegionUtils class

Returns:

the parsed region metadata

Throws:

IOException - if the resource is not found or cannot be parsed

loadMetadataFromResource

public static RegionMetadata loadMetadataFromResource(Class<?> clazz,
                                      String name)
                                               throws IOException

Loads a set of region metadata from an XML file stored as a resource of the classloader used to load the given class.

Parameters:

clazz - the class to use as a base for the resource

name - the path to the resource, relative to the given class

Returns:

the parsed region metadata

Throws:

IOException - if the resource is not found or cannot be parsed

loadMetadataFromResource

public static RegionMetadata loadMetadataFromResource(ClassLoader classLoader,
                                      String name)
                                               throws IOException

Loads a set of region metadata from an XML file stored as a resource of the given classloader.

Parameters:

classLoader - the class loader to load the resource from

name - the path to the resource

Returns:

the parsed region metadata

Throws:

IOException - if the resource is not found or cannot be parsed

loadMetadataFromInputStream

public static RegionMetadata loadMetadataFromInputStream(InputStream stream)
                                                  throws IOException

Loads a set of region metadata from an arbitrary InputStream containing an XML file.

Parameters:

stream - the stream to load from

Returns:

the loaded region metadata

Throws:

IOException - on error reading from the stream

init

@Deprecated
public static void init()

Deprecated. in favor of initialize()

This method no longer attempts to retrieve region metadata from CloudFront, as that file is no longer being maintained and the version bundled with the SDK is likely to be more up-to-date.

It's deprecated to signal that it no longer has any possibility of retrieving a newer set of metadata than was previously loaded. If you are simply wanting to reinitialize from the bundled region metadata, call initialize. If you want to maintain your own remote copy of the region metadata and periodically refresh it at runtime, call initializeFromURI.

initialize

public static void initialize()

Initializes the region metadata by loading from the default hierarchy of region metadata locations.

initializeFromURI

public static void initializeFromURI(URI uri)

Loads a set of region metadata by downloading an XML file from the given URI and parsing it.

Parameters:

uri - the uri of the XML file to parse

Throws:

AmazonClientException - on error

initializeFromURI

public static void initializeFromURI(URI uri,
                     ClientConfiguration config)

Loads a set of region metadata by downloading an XML file from the given URI and parsing it.

Parameters:

uri - the uri of the XML file to parse

config - configuration for the HTTP client to use to fetch the file

Throws:

AmazonClientException - on error

initializeFromFile

public static void initializeFromFile(File file)

Initializes the region metadata singleton from an XML file on disk.

Parameters:

file - the file to load from

Throws:

AmazonClientException - on error opening or reading from the file

initializeFromResource

public static void initializeFromResource(String name)

Initializes the region metadata singleton from an XML file stored as a resource of the classloader used to load the RegionUtils class.

Parameters:

name - the path of the resource, relative to the RegionUtils class

Throws:

AmazonClientException - on error

initializeFromResource

public static void initializeFromResource(Class<?> clazz,
                          String name)

Initializes the region metadata singleton from the given resource.

Parameters:

clazz - the class to use as a base for the resource

name - the path to the resource, relative to the given class

Throws:

AmazonClientException - on error

initializeFromResource

public static void initializeFromResource(ClassLoader classLoader,
                          String name)

Initializes the region metadata singleton from the given resource.

Parameters:

classLoader - the class loader to use to load the resource

name - the path to the resource

Throws:

AmazonClientException - on error

initializeWithMetadata

public static void initializeWithMetadata(RegionMetadata metadata)

Directly sets the singleton RegionMetadata instance.

Parameters:

metadata - the new region metadata object