RegionImpl.java

/*
 * Copyright 2011-2012 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.eclipse.core.regions;

import java.util.HashMap;
import java.util.Map;

import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.swt.graphics.Image;

import com.amazonaws.eclipse.core.AwsToolkitCore;

/**
 * Standard, read-only implementation of region initialized from regions.xml
 * at startup.
 */
class RegionImpl implements Region {

    private final String name;
    private final String id;
    private final String flagIconPath;
    private final Map<String, String> serviceEndpoints = new HashMap<String, String>();
    private final Map<String, Service> servicesByName = new HashMap<String, Service>();


    public RegionImpl(String name, String id, String flagIconPath) {
        this.name = name;
        this.id = id;
        this.flagIconPath = flagIconPath;
    }

    /**
     * The display name for this region. This is the value that should be shown
     * in UIs when this region is used.
     *
     * @return The display name for this region.
     */
    public String getName() {
        return name;
    }

    /**
     * The unique system ID for this region; ex: us-east-1.
     *
     * @return The unique system ID for this region.
     */
    public String getId() {
        return id;
    }

    /**
     * Returns 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.
     */
    public Map<String, String> getServiceEndpoints() {
        return serviceEndpoints;
    }

    /**
     * Returns a map of the available services in this region. THe keys of the
     * map are service abbreviations, as defined in {@link ServiceAbbreviations},
     * and the values are {@link Service} objects that provide information on
     * connecting to the service.
     *
     * @return A map of the available services in this region.
     */
    public Map<String, Service> getServicesByName() {
        return servicesByName;
    }

    /**
     * Returns the endpoint for the service given.
     *
     * @see ServiceAbbreviations
     */
    public String getServiceEndpoint(String serviceName) {
        return serviceEndpoints.get(serviceName);
    }

    /**
     * Returns whether the given service is supported in this region.
     *
     * @see ServiceAbbreviations
     */
    public boolean isServiceSupported(String serviceName) {
        return serviceEndpoints.containsKey(serviceName);
    }

    /**
     * Returns the relative path to a small flag icon representing this region.
     */
    public String getFlagIconPath() {
        return flagIconPath;
    }

    /**
     * Returns the image for this region's flag.
     */
    public Image getFlagImage() {
        Image image = AwsToolkitCore.getDefault().getImageRegistry().get(AwsToolkitCore.IMAGE_FLAG_PREFIX + id);
        if ( image == null ) {
            image = AwsToolkitCore.getDefault().getImageRegistry().get(AwsToolkitCore.IMAGE_AWS_ICON);
        }
        return image;
    }

    /**
     * Returns the flag's image descriptor.
     */
    public ImageDescriptor getFlagImageDescriptor() {
        ImageDescriptor descriptor = AwsToolkitCore.getDefault().getImageRegistry()
                .getDescriptor(AwsToolkitCore.IMAGE_FLAG_PREFIX + id);
        if ( descriptor == null ) {
            descriptor = AwsToolkitCore.getDefault().getImageRegistry().getDescriptor(AwsToolkitCore.IMAGE_AWS_ICON);
        }
        return descriptor;
    }

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof RegionImpl == false) {
            return false;
        }

        RegionImpl region = (RegionImpl)obj;
        return this.getId().equals(region.getId());
    }

    @Override
    public String toString() {
        return "Region: " + name + " (" + id + ")";
    }
}