com.ibm.cloud.objectstorage.partitions

Class PartitionMetadataProvider

java.lang.Object

com.ibm.cloud.objectstorage.regions.AbstractRegionMetadataProvider

com.ibm.cloud.objectstorage.partitions.PartitionMetadataProvider

All Implemented Interfaces:

RegionMetadataProvider

public class PartitionMetadataProvider
extends AbstractRegionMetadataProvider

Region metadata provider based on partitions.

Constructor Summary

Constructors

Constructor and Description
PartitionMetadataProvider(List<Partition> partitions)

Method Summary

Modifier and Type	Method and Description
Region	getRegion(String regionName) Returns the region with the name given, if it exists in the metadata or if it can be derived from the metadata.
List<Region>	getRegions() Returns an immutable list of all regions known to this region metadata object, in no particular order.
List<Region>	getRegionsForService(String serviceName) Returns a list of the regions that support the service given.
Region	tryGetRegionByEndpointDnsSuffix(String endpoint) Returns the region associated with the specified endpoint by searching the endpoint configuration for a partition that matches the DNS suffix of the provided endpoint and extracting the region name based on the endpoint pattern for that partition.
Region	tryGetRegionByExplicitEndpoint(String endpoint) Returns the region associated with the specified endpoint by searching the endpoint configuration for an endpoint that is explicitly listed.

Methods inherited from class com.ibm.cloud.objectstorage.regions.AbstractRegionMetadataProvider

getHost, getRegionByEndpoint

Methods inherited from class java.lang.Object

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

Constructor Detail

PartitionMetadataProvider

public PartitionMetadataProvider(List<Partition> partitions)

Method Detail

getRegions

public List<Region> getRegions()

Description copied from interface: RegionMetadataProvider

Returns an immutable list of all regions known to this region metadata object, in no particular order.

Returns:

an immutable list of all regions

getRegion

public Region getRegion(String regionName)

Description copied from interface: RegionMetadataProvider

Returns the region with the name given, if it exists in the metadata or if it can be derived from the metadata. Otherwise, returns null.

Parameters:

regionName - the name of the region to search for

Returns:

the corresponding region, if it exists or derived.

getRegionsForService

public List<Region> getRegionsForService(String serviceName)

Description copied from interface: RegionMetadataProvider

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

Parameters:

serviceName - The service endpoint prefix which can be retrieved from the constant ENDPOINT_PREFIX of the specific service client interface, e.g. AmazonEC2.ENDPOINT_PREFIX.

Returns:

the list of regions with support for the given service

tryGetRegionByExplicitEndpoint

public Region tryGetRegionByExplicitEndpoint(String endpoint)

Description copied from interface: RegionMetadataProvider

Returns the region associated with the specified endpoint by searching the endpoint configuration for an endpoint that is explicitly listed. This is likely to be null, because most endpoints are not explicitly listed in the endpoints file. This is mostly useful for retrieving the region of non-standard endpoints that do not include the region in the host name. These include global endpoints (budgets.amazonaws.com), Unlike RegionMetadataProvider.getRegionByEndpoint(String), this returns null on failure instead of raising an exception.

Parameters:

endpoint - The endpoint to look up in the region metadata.

Returns:

The region, or null if it cannot be determined.

tryGetRegionByEndpointDnsSuffix

public Region tryGetRegionByEndpointDnsSuffix(String endpoint)

Description copied from interface: RegionMetadataProvider

Returns the region associated with the specified endpoint by searching the endpoint configuration for a partition that matches the DNS suffix of the provided endpoint and extracting the region name based on the endpoint pattern for that partition. This may be wrong if the service does not follow the endpoint pattern for the partition. This returns null if the endpoint provided does not appear to include a region, or does not match a known partition DNS suffix. Unlike RegionMetadataProvider.getRegionByEndpoint(String), this returns null on failure instead of raising an exception.

Parameters:

endpoint - The endpoint to look up in the region metadata based on the DNS suffix.

Returns:

The region, or null if it cannot be determined.