com.ibm.cloud.objectstorage.regions

Class RegionUtils

java.lang.Object

com.ibm.cloud.objectstorage.regions.RegionUtils

public class RegionUtils
extends Object

Utilities for working with regions.

Constructor Summary

Constructors

Constructor and Description
RegionUtils()

Method Summary

Modifier and Type	Method and Description
static Region	getRegion(String regionName) Returns the region with the given regionName and proper partition if found in region metadata.
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.
static void	init() Deprecated. in favor of RegionUtils.initialize()
static void	initialize() Initializes the region metadata by loading from the default hierarchy of region metadata locations.
static void	initializeFromFile(File file) Deprecated.
static void	initializeFromResource(Class<?> clazz, String name) Deprecated.
static void	initializeFromResource(ClassLoader classLoader, String name) Deprecated.
static void	initializeFromResource(String name) Deprecated.
static void	initializeFromURI(URI uri) Deprecated.
static void	initializeFromURI(URI uri, ClientConfiguration config) Deprecated.
static void	initializeWithMetadata(RegionMetadata metadata) Directly sets the singleton RegionMetadata instance.
static RegionMetadata	loadMetadataFromFile(File file) Deprecated.
static RegionMetadata	loadMetadataFromInputStream(InputStream stream) Deprecated.
static RegionMetadata	loadMetadataFromResource(Class<?> clazz, String name) Deprecated.
static RegionMetadata	loadMetadataFromResource(ClassLoader classLoader, String name) Deprecated.
static RegionMetadata	loadMetadataFromResource(String name) Deprecated.
static RegionMetadata	loadMetadataFromURI(URI uri) Deprecated.
static RegionMetadata	loadMetadataFromURI(URI uri, ClientConfiguration config) Deprecated.

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

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

initialize

public static void initialize()

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

initializeWithMetadata

public static void initializeWithMetadata(RegionMetadata metadata)

Directly sets the singleton RegionMetadata instance.

Parameters:

metadata - the new region metadata object

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.

Parameters:

serviceAbbreviation - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface.

getRegion

public static Region getRegion(String regionName)

Returns the region with the given regionName and proper partition if found in region metadata. Otherwise, returns a Region object with given regionName and aws partition.

loadMetadataFromURI

@Deprecated
public static RegionMetadata loadMetadataFromURI(URI uri)
                                                      throws IOException

Deprecated.

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

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

Deprecated.

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

@Deprecated
public static RegionMetadata loadMetadataFromFile(File file)
                                                       throws IOException

Deprecated.

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

@Deprecated
public static RegionMetadata loadMetadataFromResource(String name)
                                                           throws IOException

Deprecated.

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

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

Deprecated.

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

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

Deprecated.

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

@Deprecated
public static RegionMetadata loadMetadataFromInputStream(InputStream stream)
                                                              throws IOException

Deprecated.

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 RegionUtils.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.

initializeFromURI

@Deprecated
public static void initializeFromURI(URI uri)

Deprecated.

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:

SdkClientException - on error

initializeFromURI

@Deprecated
public static void initializeFromURI(URI uri,
                                                 ClientConfiguration config)

Deprecated.

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:

SdkClientException - on error

initializeFromFile

@Deprecated
public static void initializeFromFile(File file)

Deprecated.

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

Parameters:

file - the file to load from

Throws:

SdkClientException - on error opening or reading from the file

initializeFromResource

@Deprecated
public static void initializeFromResource(String name)

Deprecated.

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:

SdkClientException - on error

initializeFromResource

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

Deprecated.

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:

SdkClientException - on error

initializeFromResource

@Deprecated
public static void initializeFromResource(ClassLoader classLoader,
                                                      String name)

Deprecated.

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:

SdkClientException - on error