com.amazonaws.regions.Region Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-core Show documentation
Show all versions of aws-java-sdk-core Show documentation
The AWS SDK for Java Mobile - Core module holds the classes that is used by the individual service clients to interact with Amazon Web Services. Users need to depend on aws-java-sdk artifact for accessing individual client classes.
/*
* Copyright 2013-2018 Amazon Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazonaws.regions;
import com.amazonaws.AmazonWebServiceClient;
import com.amazonaws.ClientConfiguration;
import com.amazonaws.auth.AWSCredentialsProvider;
import java.lang.reflect.Constructor;
import java.util.HashMap;
import java.util.Map;
/**
* Metadata for an AWS region, including its name and what services are
* available in it.
*/
public final class Region {
private static final String DEFAULT_DOMAIN = "amazonaws.com";
private final String name;
private final String domain;
private final Map serviceEndpoints =
new HashMap();
private final Map httpSupport =
new HashMap();
private final Map httpsSupport =
new HashMap();
Region(final String name, final String domain) {
this.name = name;
if (domain == null || domain.isEmpty()) {
this.domain = DEFAULT_DOMAIN;
} else {
this.domain = domain;
}
}
/**
* @param region the region.
* @return the region with the id given, or null if it cannot be found in
* the current regions.xml file.
*/
public static Region getRegion(Regions region) {
return RegionUtils.getRegion(region.getName());
}
/**
* @param regionString the region represented as a string. i.e. us-east-1
* @return the region with the id given, or null if it cannot be found in
* the current regions.xml file.
*/
public static Region getRegion(String regionString) {
return RegionUtils.getRegion(regionString);
}
/**
* The unique system ID for this region; ex: "us-east-1".
*
* @return The unique system ID for this region.
*/
public String getName() {
return name;
}
/**
* Returns the domain for this region; ex: "amazonaws.com".
*
* @return The domain for this region.
*/
public String getDomain() {
return domain;
}
/**
* @return a map of the available services in this region and their
* endpoints. The keys of the map are service abbreviations, as defined in
* {@link ServiceAbbreviations}, and the values are the endpoint URLs.
*
* @return A map of the available services in this region.
*/
Map getServiceEndpoints() {
return serviceEndpoints;
}
Map getHttpSupport() {
return httpSupport;
}
Map getHttpsSupport() {
return httpsSupport;
}
/**
* @param serviceName the service name.
* @return the endpoint for the service given.
*
* @see ServiceAbbreviations
*/
public String getServiceEndpoint(String serviceName) {
return serviceEndpoints.get(serviceName);
}
/**
* @param serviceName the service name.
* @return whether the given service is supported in this region.
*
* @see ServiceAbbreviations
*/
public boolean isServiceSupported(String serviceName) {
return serviceEndpoints.containsKey(serviceName);
}
/**
* @param serviceName the service name.
* @return whether the given service support the https protocol in this
* region.
*
* @see ServiceAbbreviations
*/
public boolean hasHttpsEndpoint(String serviceName) {
return httpsSupport.containsKey(serviceName) && httpsSupport.get(serviceName);
}
/**
* @param serviceName the service name.
* @return whether the given service support the http protocol in this
* region.
*
* @see ServiceAbbreviations
*/
public boolean hasHttpEndpoint(String serviceName) {
return httpSupport.containsKey(serviceName) && httpSupport.get(serviceName);
}
/**
* Creates a new service client of the class given and configures it. If
* credentials or config are null, defaults will be used.
*
* @param serviceClass The service client class to instantiate, e.g.
* AmazonS3Client.class
* @param credentials The credentials provider to use, or null for the
* default credentials provider
* @param config The configuration to use, or null for the default
* configuration
* @param the AmazonWebServiceClient type.
* @return the AmazonWebServiceClient.
* @see ServiceAbbreviations
*/
public T createClient(Class serviceClass,
AWSCredentialsProvider credentials,
ClientConfiguration config) {
Constructor constructor;
T client;
try {
if (credentials == null && config == null) {
constructor = serviceClass.getConstructor();
client = constructor.newInstance();
} else if (credentials == null) {
constructor = serviceClass.getConstructor(ClientConfiguration.class);
client = constructor.newInstance(config);
} else if (config == null) {
constructor = serviceClass.getConstructor(AWSCredentialsProvider.class);
client = constructor.newInstance(credentials);
} else {
constructor = serviceClass.getConstructor(AWSCredentialsProvider.class,
ClientConfiguration.class);
client = constructor.newInstance(credentials, config);
}
client.setRegion(this);
return client;
} catch (Exception e) {
throw new RuntimeException("Couldn't instantiate instance of " + serviceClass, e);
}
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof Region))
return false;
Region region = (Region) obj;
return this.getName().equals(region.getName());
}
@Override
public int hashCode() {
return getName().hashCode();
}
@Override
public String toString() {
return getName();
}
}