• Home
• com.emc.vipr
• aws-java-sdk
• 1.7.5
• source code
• EC2MetadataUtils.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.amazonaws.util.EC2MetadataUtils Maven / Gradle / Ivy

/*
 * Copyright 2013-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. 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.util;

import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import com.amazonaws.AmazonClientException;
import com.amazonaws.internal.EC2MetadataClient;
import com.amazonaws.util.json.JSONUtils;

/**
 * Utility class for retrieving Amazon EC2 instance metadata.

 * You can use the data to build more generic AMIs that can be modified by
 * configuration files supplied at launch time. For example, if you run web
 * servers for various small businesses, they can all use the same AMI and
 * retrieve their content from the Amazon S3 bucket you specify at launch. To
 * add a new customer at any time, simply create a bucket for the customer, add
 * their content, and launch your AMI.

 * 
 * More information about Amazon EC2 Metadata
 * @see Amazon EC2 User Guide >> Instance Metadata
 */
public class EC2MetadataUtils {
	
	private static final String EC2_METADATA_ROOT = "/latest/meta-data";
	private static final String EC2_USERDATA_ROOT = "/latest/user-data/";
	
	private static final int DEFAULT_QUERY_RETRIES = 3;
	private static final int MINIMUM_RETRY_WAIT_TIME_MILLISECONDS = 250;
	private static Map cache = new HashMap();
	private static EC2MetadataClient ec2MetadataClient = new EC2MetadataClient();
	
	private static final Log log = LogFactory.getLog(EC2MetadataUtils.class);
	
	/**
	 * Get the AMI ID used to launch the instance.
	 */
	public static String getAmiId() {
		return fetchData(EC2_METADATA_ROOT + "/ami-id");
	}
	
	/**
	 * Get the index of this instance in the reservation.
	 */
	public static String getAmiLaunchIndex() {
		return fetchData(EC2_METADATA_ROOT + "/ami-launch-index");
	}

	/**
	 * Get the manifest path of the AMI with which the instance was launched.
	 */
	public static String getAmiManifestPath() {
		return fetchData(EC2_METADATA_ROOT + "/ami-manifest-path");
	}
	
	/**
	 * Get the list of AMI IDs of any instances that were rebundled to created this AMI.
	 * Will only exist if the AMI manifest file contained an ancestor-amis key.
	 */
	public static List getAncestorAmiIds() {
		return getItems(EC2_METADATA_ROOT + "/ancestor-ami-ids");
	}
	
	/**
	 * Notifies the instance that it should reboot in preparation for bundling. 
	 * Valid values: none | shutdown | bundle-pending.
	 */
	public static String getInstanceAction() {
		return fetchData(EC2_METADATA_ROOT + "/instance-action");
	}
	
	/**
	 * Get the ID of this instance.
	 */
	public static String getInstanceId() {
		return fetchData(EC2_METADATA_ROOT + "/instance-id");
	}
	
	/**
	 * Get the type of the instance.
	 */
	public static String getInstanceType() {
		return fetchData(EC2_METADATA_ROOT + "/instance-type");
	}
	
	/**
	 * Get the local hostname of the instance. In cases where multiple network interfaces are present,
	 * this refers to the eth0 device (the device for which device-number is 0).
	 */
	public static String getLocalHostName() {
		return fetchData(EC2_METADATA_ROOT + "/local-hostname");
	}
	
	/**
	 * Get the MAC address of the instance. In cases where multiple network interfaces are present,
	 * this refers to the eth0 device (the device for which device-number is 0).
	 */
	public static String getMacAddress() {
		return fetchData(EC2_METADATA_ROOT + "/mac");
	}
	
	/**
	 * Get the private IP address of the instance. In cases where multiple network interfaces are present,
	 * this refers to the eth0 device (the device for which device-number is 0).
	 */
	public static String getPrivateIpAddress() {
		return fetchData(EC2_METADATA_ROOT + "/local-ipv4");
	}
	
	/**
	 * Get the Availability Zone in which the instance launched. 
	 */
	public static String getAvailabilityZone() {
		return fetchData(EC2_METADATA_ROOT + "/placement/availability-zone");
	}
	
	/**
	 * Get the list of product codes associated with the instance, if any.
	 */
	public static List getProductCodes() {
		return getItems(EC2_METADATA_ROOT + "/product-codes");
	}
	
	/**
	 * Get the public key. Only available if supplied at instance launch time.
	 */
	public static String getPublicKey() {
		return fetchData(EC2_METADATA_ROOT + "/public-keys/0/openssh-key");
	}
	
	/**
	 * Get the ID of the RAM disk specified at launch time, if applicable.
	 */
	public static String getRamdiskId() {
		return fetchData(EC2_METADATA_ROOT + "/ramdisk-id");
	}
	
	/**
	 * Get the ID of the reservation.
	 */
	public static String getReservationId() {
		return fetchData(EC2_METADATA_ROOT + "/reservation-id");
	}
	
	/**
	 * Get the list of names of the security groups applied to the instance.
	 */
	public static List getSecurityGroups() {
		return getItems(EC2_METADATA_ROOT + "/security-groups");
	}
	
	/**
	 * Get information about the last time the instance profile was updated, 
	 * including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId.
	 */
	public static IAMInfo getIAMInstanceProfileInfo() {
		String json = getData(EC2_METADATA_ROOT + "/iam/info");
		if (null == json)
			return null;
		IAMInfo info;
		try {
			info = JSONUtils.toObject(IAMInfo.class, json);
		}
		catch (Exception e) {
			info = null;
		}
		return info;
	}
	
	/**
	 * Returns the temporary security credentials (AccessKeyId, SecretAccessKey, SessionToken, and Expiration)
	 * associated with the IAM roles on the instance.
	 */
	public static Map getIAMSecurityCredentials() {
		Map credentialsInfoMap = new HashMap();
		
		List credentials = getItems(EC2_METADATA_ROOT + "/iam/security-credentials");
		if (null != credentials) {
			for (String credential : credentials) {
				String json = getData(EC2_METADATA_ROOT + "/iam/security-credentials/" + credential);
				try {
					IAMSecurityCredential credentialInfo = JSONUtils.toObject(IAMSecurityCredential.class, json);
					credentialsInfoMap.put(credential, credentialInfo);
				} catch(Exception e) {
					log.warn("Unable to process the credential(" + credential + "). " + e.getMessage(), e);
				}
			}
		}
		return credentialsInfoMap;
	}
	
	/**
	 * Get the virtual devices associated with the ami, root, ebs, and swap.
	 */
	public static Map getBlockDeviceMapping() {
		Map blockDeviceMapping = new HashMap();
		
		List devices = getItems(EC2_METADATA_ROOT + "/block-device-mapping");
		for (String device : devices) {
			blockDeviceMapping.put(device, getData(EC2_METADATA_ROOT + "/block-device-mapping/" + device));
		}
		return blockDeviceMapping;
	}
	
	/**
	 * Get the list of network interfaces on the instance.
	 */
	public static List getNetworkInterfaces() {
		List networkInterfaces = new LinkedList();
		
		List macs = getItems(EC2_METADATA_ROOT + "/network/interfaces/macs/");
		for (String mac : macs) {
			String key = mac.trim();
			if (key.endsWith("/"))
				key = key.substring(0, key.length() - 1);
			networkInterfaces.add(new NetworkInterface(key));
		}
		return networkInterfaces;
	}
	
	/**
	 * Get the metadata sent to the instance
	 */
	public static String getUserData() {
		return getData(EC2_USERDATA_ROOT);
	}
	
	public static String getData(String path) {
		return getData(path, DEFAULT_QUERY_RETRIES);
	}
	
	public static String getData(String path, int tries) {
		List items = getItems(path, tries, true);
		if (null != items && items.size() > 0)
			return items.get(0);
		return null;
	}
	
	public static List getItems(String path) {
		return getItems(path, DEFAULT_QUERY_RETRIES, false);
	}
	
	public static List getItems(String path, int tries) {
		return getItems(path, tries, false);
	}
	
	private static List getItems(String path, int tries, boolean slurp) {
		if (tries == 0)
			throw new AmazonClientException("Unable to contact EC2 metadata service.");
		
		List items;
		try {
			String response = ec2MetadataClient.readResource(path);
			if (slurp)
				items = Collections.singletonList(response);
			else
				items = Arrays.asList(response.split("\n"));
			return items;
		} catch (AmazonClientException ace) {
			log.warn("Unable to retrieve the requested metadata.");
			return null;
		} catch (Exception e) {
			// Retry on any other exceptions
			int pause = (int) (Math.pow(2, DEFAULT_QUERY_RETRIES - tries) * MINIMUM_RETRY_WAIT_TIME_MILLISECONDS);
			try {
				Thread.sleep(pause < MINIMUM_RETRY_WAIT_TIME_MILLISECONDS ? MINIMUM_RETRY_WAIT_TIME_MILLISECONDS : pause);
			} catch (InterruptedException e1) {
				Thread.currentThread().interrupt();
			}
			return getItems(path, tries - 1, slurp);
		}
	}
	
	private static String fetchData(String path) {
		return fetchData(path, false);
	}
	
	private static String fetchData(String path, boolean force) {
		try {
			if (force || !cache.containsKey(path))
				cache.put(path, getData(path));
			return cache.get(path);
		} catch (Exception e) {
			return null;
		}
	}
	
	/**
	 * Information about the last time the instance profile was updated,
	 * including the instance's LastUpdated date, InstanceProfileArn, and InstanceProfileId.
	 */
	public static class IAMInfo {
		public String code;
		public String message;
		public String lastUpdated;
		public String instanceProfileArn;
		public String instanceProfileId;
	}
	
	/**
	 * The temporary security credentials (AccessKeyId, SecretAcessKey, SessionToken, and Expiration)
	 * associated with the IAM role.
	 */
	public static class IAMSecurityCredential {
		public String code;
		public String message;
		public String lastUpdated;
		public String type;
		public String accessKeyId;
		public String secretAcessKey;
		public String token;
		public String expiration;
	}
	
	/**
	 * All of the metada associated with a network interface on the instance.
	 */
	public static class NetworkInterface {
		private String path;
		private String mac;
		
		private List availableKeys;
		private Map data = new HashMap();
		
		private NetworkInterface() {}
		
		public NetworkInterface(String macAddress) {
			mac = macAddress;
			path = "/network/interfaces/macs/" + mac + "/";
		}
		
		/**
		 * The interface's Media Acess Control (mac) address
		 */
		public String getMacAddress() {
			return mac;
		}
		
		/**
		 * The ID of the owner of the network interface.

		 * In multiple-interface environments, an interface can be attached by a third party,
		 * such as Elastic Load Balancing. Traffic on an interface is always billed to the interface owner.
		 */
		public String getOwnerId() {
			return getData("owner-id");
		}
		
		/**
		 * The interface's profile.
		 */
		public String getProfile() {
			return getData("profile");
		}
		
		/**
		 * The interface's local hostname.
		 */
		public String getHostname() {
			return getData("local-hostname");
		}
		
		/**
		 * The private IP addresses associated with the interface.
		 */
		public List getLocalIPv4s()	 {
			return getItems("local-ipv4s");
		}
		
		/**
		 * The interface's public hostname.
		 */
		public String getPublicHostname() {
			return getData("public-hostname");
		}
		
		/**
		 * The elastic IP addresses associated with the interface.

		 * There may be multiple IP addresses on an instance.
		 */
		public List getPublicIPv4s() {
			return getItems("public-ipv4s");
		}
		
		/**
		 * Security groups to which the network interface belongs.
		 */
		public List getSecurityGroups() {
			return getItems("security-groups");
		}
		
		/**
		 * IDs of the security groups to which the network interface belongs. Returned only for 
		 * Amazon EC2 instances launched into a VPC.
		 */
		public List getSecurityGroupIds() {
			return getItems("security-group-ids");
		}
		
		/**
		 * The CIDR block of the Amazon EC2-VPC subnet in which the interface resides.

		 * Returned only for Amazon EC2 instances launched into a VPC.
		 */
		public String getSubnetIPv4CidrBlock() {
			return getData("subnet-ipv4-cidr-block");
		}
		
		/**
		 * The CIDR block of the Amazon EC2-VPC subnet in which the interface resides.

		 * Returned only for Amazon EC2 instances launched into a VPC.
		 */
		public String getVpcId() {
			return getData("vpc-id");
		}
		
		/**
		 * Get the private IPv4 address(es) that are associated with the public-ip address 
		 * and assigned to that interface.
		 * @param publicIp
		 * 			The public IP address
		 * @return
		 * 			Private IPv4 address(es) associated with the public IP address.
		 */
		public List getIPv4Association(String publicIp) {
			return EC2MetadataUtils.getItems(EC2_METADATA_ROOT + path + "ipv4-associations/" + publicIp);
		}
		
		private String getData(String key) {
			if (data.containsKey(key))
				return data.get(key);
			
			// Since the keys are variable, cache a list of which ones are available
			// to prevent unnecessary trips to the service.
			if (null == availableKeys)
				availableKeys = EC2MetadataUtils.getItems(EC2_METADATA_ROOT + path);
			
			if (availableKeys.contains(key)) {
				data.put(key, EC2MetadataUtils.getData(EC2_METADATA_ROOT + path + key));
				return data.get(key);
			}
			else
				return null;
		}
		
		private List getItems(String key) {
			if (null == availableKeys)
				availableKeys = EC2MetadataUtils.getItems(EC2_METADATA_ROOT + path);
			
			if (availableKeys.contains(key))
				return EC2MetadataUtils.getItems(EC2_METADATA_ROOT + path + key);
			else
				return new LinkedList();
		}
	}
}