org.kuali.common.aws.ec2.impl

Class DefaultEC2Service

java.lang.Object

org.kuali.common.aws.ec2.impl.DefaultEC2Service

All Implemented Interfaces:

EC2Service

public final class DefaultEC2Service
extends Object
implements EC2Service

This service implementation performs operations using a single set of AWS credentials on a single EC2 region.

Constructor Summary

Constructors

Constructor and Description
DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials)
DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials, com.amazonaws.services.ec2.model.Region region)
DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials, String region)
DefaultEC2Service(EC2ServiceContext context, org.kuali.common.util.wait.WaitService service)

Method Summary

Methods

Modifier and Type	Method and Description
void	allowTermination(String instanceId) Set a flag that allows an Amazon EC2 instance to be terminated.
String	attachVolume(VolumeRequest request)
protected void	checkSizeEquals(Collection<?> c, int size)
protected com.amazonaws.services.ec2.model.EbsBlockDevice	convert(com.amazonaws.services.ec2.model.EbsInstanceBlockDevice device, String snapshotId, int sizeInGigabytes)
protected com.amazonaws.services.ec2.model.BlockDeviceMapping	convert(com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping mapping, String snapshotId, int sizeInGigabytes)
String	copyAmi(String region, String ami)
String	copyAmi(String region, String ami, com.google.common.base.Optional<String> name)
String	copyAmi(String region, String ami, String name)
com.amazonaws.services.ec2.model.Image	createAmi(CreateAMIRequest request)
protected com.amazonaws.services.ec2.model.Image	createAmi(CreateAMIRequest create, com.amazonaws.services.ec2.model.Instance instance, com.amazonaws.services.ec2.model.Snapshot snapshot)
void	createSecurityGroup(KualiSecurityGroup group) Create a new security group (it must not exist yet)
com.amazonaws.services.ec2.model.Snapshot	createSnapshot(String volumeId, String description, int timeoutMillis) Snapshot a volume.
String	createVolume(CreateVolumeRequest request)
String	createVolume(String zone, int size)
void	deleteSnapshot(String snapshotId)
String	deleteVolume(String volumeId)
String	detachVolume(VolumeRequest request)
protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.BlockDeviceMapping>	findMatch(List<com.amazonaws.services.ec2.model.BlockDeviceMapping> mappings, com.amazonaws.services.ec2.model.BlockDeviceMapping mapping)
String	getAccessKey()
com.amazonaws.services.ec2.model.Image	getAmi(String ami)
EC2ServiceContext	getContext()
com.amazonaws.services.ec2.model.Image	getImage(String imageId) Return an Image object given an image id
List<com.amazonaws.services.ec2.model.Image>	getImages()
com.amazonaws.services.ec2.model.Instance	getInstance(String instanceId) Return an Amazon EC2 instance object given an instance id.
List<com.amazonaws.services.ec2.model.Instance>	getInstances()
protected List<com.amazonaws.services.ec2.model.Instance>	getInstances(com.amazonaws.services.ec2.model.DescribeInstancesResult result)
List<com.amazonaws.services.ec2.model.Instance>	getInstances(List<String> instanceIds)
protected com.amazonaws.services.ec2.model.IpPermission	getIpPermission(Permission perm)
protected List<com.amazonaws.services.ec2.model.IpPermission>	getIpPermissions(Collection<Permission> permissions)
protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.KeyPairInfo>	getKeyPairInfo(String name, List<com.amazonaws.services.ec2.model.KeyPairInfo> list)
List<com.amazonaws.services.ec2.model.Image>	getMyImages() Return a list of all the AMI's you own.
protected List<String>	getNames(List<KualiSecurityGroup> groups)
protected Permission	getPermission(com.amazonaws.services.ec2.model.IpPermission perm)
protected List<Permission>	getPermissions(Collection<com.amazonaws.services.ec2.model.IpPermission> permissions)
String	getRegion()
protected com.amazonaws.services.ec2.model.BlockDeviceMapping	getRootBlockDeviceMapping(com.amazonaws.services.ec2.model.Image image)
protected String	getRootVolumeId(com.amazonaws.services.ec2.model.Instance instance)
protected com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping	getRootVolumeMapping(com.amazonaws.services.ec2.model.Instance instance)
protected com.amazonaws.services.ec2.model.BlockDeviceMapping	getRootVolumeMapping(com.amazonaws.services.ec2.model.Instance instance, String snapshotId, RootVolume rootVolume)
protected com.amazonaws.services.ec2.model.RunInstancesRequest	getRunInstanceRequest(LaunchInstanceContext context) Return a request that spins up exactly one instance.
com.google.common.base.Optional<com.amazonaws.services.ec2.model.SecurityGroup>	getSecurityGroup(String name) Return the security group object associated with name
List<String>	getSecurityGroupNames() Return a list containing the names of all the security groups.
com.amazonaws.services.ec2.model.Snapshot	getSnapshot(String snapshotId) Return a snapshot object, given a snapshot id
protected String	getStatus(List<com.amazonaws.services.ec2.model.InstanceStatus> statuses, InstanceStatusType type, String name)
String	getStatus(String instanceId, InstanceStatusType type, String statusName) Each Amazon EC2 instance has a list of statuses associated with it.
protected com.google.common.base.Optional<String>	getStatusDetail(com.amazonaws.services.ec2.model.InstanceStatusSummary summary, String name)
protected List<com.amazonaws.services.ec2.model.InstanceStatus>	getStatusList(String instanceId)
protected com.amazonaws.services.ec2.model.InstanceStatusSummary	getSummary(com.amazonaws.services.ec2.model.InstanceStatus status, InstanceStatusType type)
protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.Tag>	getTag(List<com.amazonaws.services.ec2.model.Tag> tags, String key)
protected List<com.amazonaws.services.ec2.model.BlockDeviceMapping>	getUpdatedBlockDeviceMappings(LaunchInstanceContext context)
com.amazonaws.services.ec2.model.Volume	getVolume(String volumeId)
protected org.kuali.common.util.wait.WaitContext	getWaitContext(int timeout)
String	importKey(String keyName, String publicKey) Import the public key using the given name into Amazon.
boolean	isExistingKey(String keyName) Return true if Amazon has a public key stored under this name.
boolean	isExistingSecurityGroup(String name) Return true if there is already a security group with the given name.
boolean	isOnline(String instanceId) This method returns true if the Amazon EC2 instance meets three conditions:
protected com.amazonaws.services.ec2.model.Instance	issueRunInstanceRequest(LaunchInstanceContext context)
com.amazonaws.services.ec2.model.Instance	launchInstance(LaunchInstanceContext context) Launch a single Amazon EC2 instance and wait until Amazon confirms that the instance is online and functioning.
List<com.amazonaws.services.ec2.model.Volume>	listVolumes()
protected void	logPermissionChanges(KualiSecurityGroup group, List<Permission> perms, String changeDescription)
void	preventTermination(String instanceId) Set a flag that prevent's an Amazon EC2 instance from being terminated.
protected void	preventTermination(String instanceId, boolean preventTermination)
void	purgeAmi(String imageId) Deregister the AMI and delete any snapshots associated with it.
SetPermissionsResult	setPermissions(String securityGroupName, List<Permission> permissions) Make the permissions for the indicated security group match the list provided.
com.amazonaws.services.ec2.model.Instance	startInstance(String instanceId)
void	stopInstance(String instanceId)
void	tag(String resourceId, List<com.amazonaws.services.ec2.model.Tag> tags) Create tags on the indicated Amazon EC2 resource (instance, volume, snapshot, ami, etc).
void	tag(String resourceId, com.amazonaws.services.ec2.model.Tag tag) Create tags on the indicated Amazon EC2 resource (instance, volume, snapshot, ami, etc).
void	terminateInstance(String instanceId) Terminate a single Amazon EC2 instance and wait until Amazon confirms that the instance has been terminated.
void	terminateInstanceNoWait(String instanceId)
void	terminateInstancesNoWait(List<String> instanceIds)
protected void	updateRootBlockDeviceMapping(com.amazonaws.services.ec2.model.Image ami, RootVolume rootVolume)
protected void	waitForAmiState(String imageId, String state, int timeoutMillis)
protected void	waitForOnlineConfirmation(com.amazonaws.services.ec2.model.Instance instance, LaunchInstanceContext context)
protected void	waitForSnapshotState(String snapshotId, String state, int timeoutMillis)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEC2Service

public DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials)

DefaultEC2Service

public DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials,
                 String region)

DefaultEC2Service

public DefaultEC2Service(com.amazonaws.auth.AWSCredentials credentials,
                 com.amazonaws.services.ec2.model.Region region)

DefaultEC2Service

public DefaultEC2Service(EC2ServiceContext context,
                 org.kuali.common.util.wait.WaitService service)

Method Detail

listVolumes

public List<com.amazonaws.services.ec2.model.Volume> listVolumes()

Specified by:

listVolumes in interface EC2Service

getVolume

public com.amazonaws.services.ec2.model.Volume getVolume(String volumeId)

Specified by:

getVolume in interface EC2Service

detachVolume

public String detachVolume(VolumeRequest request)

Specified by:

detachVolume in interface EC2Service

getAccessKey

public String getAccessKey()

Specified by:

getAccessKey in interface EC2Service

getRegion

public String getRegion()

Specified by:

getRegion in interface EC2Service

copyAmi

public String copyAmi(String region,
             String ami)

Specified by:

copyAmi in interface EC2Service

copyAmi

public String copyAmi(String region,
             String ami,
             String name)

Specified by:

copyAmi in interface EC2Service

copyAmi

public String copyAmi(String region,
             String ami,
             com.google.common.base.Optional<String> name)

getImages

public List<com.amazonaws.services.ec2.model.Image> getImages()

Specified by:

getImages in interface EC2Service

deleteSnapshot

public void deleteSnapshot(String snapshotId)

Specified by:

deleteSnapshot in interface EC2Service

purgeAmi

public void purgeAmi(String imageId)

Description copied from interface: EC2Service

Deregister the AMI and delete any snapshots associated with it.

Specified by:

purgeAmi in interface EC2Service

createAmi

public com.amazonaws.services.ec2.model.Image createAmi(CreateAMIRequest request)

Specified by:

createAmi in interface EC2Service

createAmi

protected com.amazonaws.services.ec2.model.Image createAmi(CreateAMIRequest create,
                                               com.amazonaws.services.ec2.model.Instance instance,
                                               com.amazonaws.services.ec2.model.Snapshot snapshot)

getRootVolumeMapping

protected com.amazonaws.services.ec2.model.BlockDeviceMapping getRootVolumeMapping(com.amazonaws.services.ec2.model.Instance instance,
                                                                       String snapshotId,
                                                                       RootVolume rootVolume)

convert

protected com.amazonaws.services.ec2.model.BlockDeviceMapping convert(com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping mapping,
                                                          String snapshotId,
                                                          int sizeInGigabytes)

convert

protected com.amazonaws.services.ec2.model.EbsBlockDevice convert(com.amazonaws.services.ec2.model.EbsInstanceBlockDevice device,
                                                      String snapshotId,
                                                      int sizeInGigabytes)

getTag

protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.Tag> getTag(List<com.amazonaws.services.ec2.model.Tag> tags,
                                                                           String key)

getRootVolumeId

protected String getRootVolumeId(com.amazonaws.services.ec2.model.Instance instance)

getRootVolumeMapping

protected com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping getRootVolumeMapping(com.amazonaws.services.ec2.model.Instance instance)

createSnapshot

public com.amazonaws.services.ec2.model.Snapshot createSnapshot(String volumeId,
                                                       String description,
                                                       int timeoutMillis)

Description copied from interface: EC2Service

Snapshot a volume. Blocks until the snapshot reaches the state "completed" or timeoutMillis has been exceeded

Specified by:

createSnapshot in interface EC2Service

getSnapshot

public com.amazonaws.services.ec2.model.Snapshot getSnapshot(String snapshotId)

Description copied from interface: EC2Service

Return a snapshot object, given a snapshot id

Specified by:

getSnapshot in interface EC2Service

waitForSnapshotState

protected void waitForSnapshotState(String snapshotId,
                        String state,
                        int timeoutMillis)

waitForAmiState

protected void waitForAmiState(String imageId,
                   String state,
                   int timeoutMillis)

getMyImages

public List<com.amazonaws.services.ec2.model.Image> getMyImages()

Description copied from interface: EC2Service

Return a list of all the AMI's you own.

Specified by:

getMyImages in interface EC2Service

checkSizeEquals

protected void checkSizeEquals(Collection<?> c,
                   int size)

getImage

public com.amazonaws.services.ec2.model.Image getImage(String imageId)

Description copied from interface: EC2Service

Return an Image object given an image id

Specified by:

getImage in interface EC2Service

importKey

public String importKey(String keyName,
               String publicKey)

Description copied from interface: EC2Service

Import the public key using the given name into Amazon.

Specified by:

importKey in interface EC2Service

isExistingKey

public boolean isExistingKey(String keyName)

Description copied from interface: EC2Service

Return true if Amazon has a public key stored under this name.

Specified by:

isExistingKey in interface EC2Service

getKeyPairInfo

protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.KeyPairInfo> getKeyPairInfo(String name,
                                                                                           List<com.amazonaws.services.ec2.model.KeyPairInfo> list)

getSecurityGroupNames

public List<String> getSecurityGroupNames()

Description copied from interface: EC2Service

Return a list containing the names of all the security groups.

Specified by:

getSecurityGroupNames in interface EC2Service

createSecurityGroup

public void createSecurityGroup(KualiSecurityGroup group)

Description copied from interface: EC2Service

Create a new security group (it must not exist yet)

Specified by:

createSecurityGroup in interface EC2Service

isExistingSecurityGroup

public boolean isExistingSecurityGroup(String name)

Description copied from interface: EC2Service

Return true if there is already a security group with the given name.

Specified by:

isExistingSecurityGroup in interface EC2Service

setPermissions

public SetPermissionsResult setPermissions(String securityGroupName,
                                  List<Permission> permissions)

Description copied from interface: EC2Service

Make the permissions for the indicated security group match the list provided.

• Any extra permissions are removed.
• Any missing permissions are created.

Specified by:

setPermissions in interface EC2Service

getSecurityGroup

public com.google.common.base.Optional<com.amazonaws.services.ec2.model.SecurityGroup> getSecurityGroup(String name)

Description copied from interface: EC2Service

Return the security group object associated with name

Specified by:

getSecurityGroup in interface EC2Service

getIpPermissions

protected List<com.amazonaws.services.ec2.model.IpPermission> getIpPermissions(Collection<Permission> permissions)

getPermissions

protected List<Permission> getPermissions(Collection<com.amazonaws.services.ec2.model.IpPermission> permissions)

getPermission

protected Permission getPermission(com.amazonaws.services.ec2.model.IpPermission perm)

getIpPermission

protected com.amazonaws.services.ec2.model.IpPermission getIpPermission(Permission perm)

getInstance

public com.amazonaws.services.ec2.model.Instance getInstance(String instanceId)

Description copied from interface: EC2Service

Return an Amazon EC2 instance object given an instance id.

Specified by:

getInstance in interface EC2Service

getInstances

public List<com.amazonaws.services.ec2.model.Instance> getInstances(List<String> instanceIds)

Specified by:

getInstances in interface EC2Service

getInstances

protected List<com.amazonaws.services.ec2.model.Instance> getInstances(com.amazonaws.services.ec2.model.DescribeInstancesResult result)

getInstances

public List<com.amazonaws.services.ec2.model.Instance> getInstances()

Specified by:

getInstances in interface EC2Service

launchInstance

public com.amazonaws.services.ec2.model.Instance launchInstance(LaunchInstanceContext context)

Description copied from interface: EC2Service

Launch a single Amazon EC2 instance and wait until Amazon confirms that the instance is online and functioning.

Specified by:

launchInstance in interface EC2Service

See Also:

terminateInstance

allowTermination

public void allowTermination(String instanceId)

Description copied from interface: EC2Service

Set a flag that allows an Amazon EC2 instance to be terminated. This does not terminate the instance. It just makes it possible for the instance to be terminated at some later point in time.

Specified by:

allowTermination in interface EC2Service

See Also:

preventTermination

preventTermination

public void preventTermination(String instanceId)

Description copied from interface: EC2Service

Set a flag that prevent's an Amazon EC2 instance from being terminated.

Specified by:

preventTermination in interface EC2Service

See Also:

allowTermination

startInstance

public com.amazonaws.services.ec2.model.Instance startInstance(String instanceId)

Specified by:

startInstance in interface EC2Service

stopInstance

public void stopInstance(String instanceId)

Specified by:

stopInstance in interface EC2Service

terminateInstance

public void terminateInstance(String instanceId)

Description copied from interface: EC2Service

Terminate a single Amazon EC2 instance and wait until Amazon confirms that the instance has been terminated.

Specified by:

terminateInstance in interface EC2Service

See Also:

launchInstance

terminateInstancesNoWait

public void terminateInstancesNoWait(List<String> instanceIds)

Specified by:

terminateInstancesNoWait in interface EC2Service

terminateInstanceNoWait

public void terminateInstanceNoWait(String instanceId)

Specified by:

terminateInstanceNoWait in interface EC2Service

tag

public void tag(String resourceId,
       List<com.amazonaws.services.ec2.model.Tag> tags)

Description copied from interface: EC2Service

Create tags on the indicated Amazon EC2 resource (instance, volume, snapshot, ami, etc).

Specified by:

tag in interface EC2Service

tag

public void tag(String resourceId,
       com.amazonaws.services.ec2.model.Tag tag)

Description copied from interface: EC2Service

Create tags on the indicated Amazon EC2 resource (instance, volume, snapshot, ami, etc).

Specified by:

tag in interface EC2Service

isOnline

public boolean isOnline(String instanceId)

Description copied from interface: EC2Service

This method returns true if the Amazon EC2 instance meets three conditions:

1. The instance is in the running state.
2. Amazon has verified that the instance is reachable. Amazon has verified that they are able to get network packets to the instance.
3. Amazon has verified that the instance's operating system is accepting traffic.

If this method returns false, the instance cannot be used in any meaningful way.

Specified by:

isOnline in interface EC2Service

getStatus

public String getStatus(String instanceId,
               InstanceStatusType type,
               String statusName)

Description copied from interface: EC2Service

Each Amazon EC2 instance has a list of statuses associated with it.

Each status has a name and value and is associated with either the ability of Amazon's internal systems to determine that status (external to the instance itself) or with the status of something going on internally to the instance.

A SYSTEM status is analogous to saying "is powered on", or "is connected to the network", but says nothing about the state of any software running on the instance.

An INSTANCE status indicates something about the state of software running on the instance, aka "is operating system running"

Specified by:

getStatus in interface EC2Service

preventTermination

protected void preventTermination(String instanceId,
                      boolean preventTermination)

getStatusList

protected List<com.amazonaws.services.ec2.model.InstanceStatus> getStatusList(String instanceId)

getStatus

protected String getStatus(List<com.amazonaws.services.ec2.model.InstanceStatus> statuses,
               InstanceStatusType type,
               String name)

getSummary

protected com.amazonaws.services.ec2.model.InstanceStatusSummary getSummary(com.amazonaws.services.ec2.model.InstanceStatus status,
                                                                InstanceStatusType type)

getStatusDetail

protected com.google.common.base.Optional<String> getStatusDetail(com.amazonaws.services.ec2.model.InstanceStatusSummary summary,
                                                      String name)

issueRunInstanceRequest

protected com.amazonaws.services.ec2.model.Instance issueRunInstanceRequest(LaunchInstanceContext context)

logPermissionChanges

protected void logPermissionChanges(KualiSecurityGroup group,
                        List<Permission> perms,
                        String changeDescription)

getWaitContext

protected org.kuali.common.util.wait.WaitContext getWaitContext(int timeout)

waitForOnlineConfirmation

protected void waitForOnlineConfirmation(com.amazonaws.services.ec2.model.Instance instance,
                             LaunchInstanceContext context)

getNames

protected List<String> getNames(List<KualiSecurityGroup> groups)

getRunInstanceRequest

protected com.amazonaws.services.ec2.model.RunInstancesRequest getRunInstanceRequest(LaunchInstanceContext context)

Return a request that spins up exactly one instance.

getUpdatedBlockDeviceMappings

protected List<com.amazonaws.services.ec2.model.BlockDeviceMapping> getUpdatedBlockDeviceMappings(LaunchInstanceContext context)

findMatch

protected com.google.common.base.Optional<com.amazonaws.services.ec2.model.BlockDeviceMapping> findMatch(List<com.amazonaws.services.ec2.model.BlockDeviceMapping> mappings,
                                                                                             com.amazonaws.services.ec2.model.BlockDeviceMapping mapping)

updateRootBlockDeviceMapping

protected void updateRootBlockDeviceMapping(com.amazonaws.services.ec2.model.Image ami,
                                RootVolume rootVolume)

getRootBlockDeviceMapping

protected com.amazonaws.services.ec2.model.BlockDeviceMapping getRootBlockDeviceMapping(com.amazonaws.services.ec2.model.Image image)

getAmi

public com.amazonaws.services.ec2.model.Image getAmi(String ami)

getContext

public EC2ServiceContext getContext()

deleteVolume

public String deleteVolume(String volumeId)

Specified by:

deleteVolume in interface EC2Service

attachVolume

public String attachVolume(VolumeRequest request)

Specified by:

attachVolume in interface EC2Service

createVolume

public String createVolume(String zone,
                  int size)

Specified by:

createVolume in interface EC2Service

createVolume

public String createVolume(CreateVolumeRequest request)

Specified by:

createVolume in interface EC2Service