com.samysadi.acs.service.vmplacement

Class VmPlacementPolicyAbstract

java.lang.Object

com.samysadi.acs.core.notifications.NotifierImpl

com.samysadi.acs.core.tracing.ProbedImpl

com.samysadi.acs.core.entity.EntityImpl

com.samysadi.acs.service.vmplacement.VmPlacementPolicyAbstract

All Implemented Interfaces:

Entity, Notifier, Probed, VmPlacementPolicy, Cloneable

Direct Known Subclasses:

VmPlacementPolicyBestFit, VmPlacementPolicyFirstFit, VmPlacementPolicyRandomFit

public abstract class VmPlacementPolicyAbstract
extends EntityImpl
implements VmPlacementPolicy

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class com.samysadi.acs.core.notifications.NotifierImpl

NotifierImpl.NotifyEvent

Constructor Summary

Constructors

Constructor and Description
VmPlacementPolicyAbstract()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canPlaceVm(VirtualMachine vm, Host host) Returns true if the vm can be placed on the given host.
VmPlacementPolicyAbstract	clone() Creates a clone of this Notifier.
CloudProvider	getParent() Returns the parent of this entity, or null if no parent is set
void	placeVm(VirtualMachine vm, Host host) Takes all actions in order to place the given vm on the given host.
Host	selectHost(VirtualMachine vm) Alias for VmPlacementPolicy.selectHost(VirtualMachine, List) where possible hosts is null.
Host	selectHost(VirtualMachine vm, List<Host> hosts) Alias for VmPlacementPolicy.selectHost(VirtualMachine, List, List) where excluded hosts is null.
Host	selectHost(VirtualMachine vm, List<Host> hosts, List<Host> excludedHosts) Selects a host where to place the given vm and returns it.
void	setParent(Entity parent) Updates the parent of this entity. This method makes sure that the old and the new parent keep their entities list updated, by automatically calling Entity.addEntity(Entity) and Entity.removeEntity(Entity).
void	unplaceVm(VirtualMachine vm) Takes all actions in order to unplaces the given vm. When all actions were taken, the VM's parent is updated (set to null).

Methods inherited from class com.samysadi.acs.core.entity.EntityImpl

addEntity, getConfig, getConfigRec, getEntities, getId, getLogger, getName, getNextId, getProperties, getProperty, getProperty, hashCode, hasParentRec, lockParent, lockParentRec, removeEntity, setConfig, setName, setProperty, toString, unlockParent, unlockParentRec, unsetProperty

Methods inherited from class com.samysadi.acs.core.tracing.ProbedImpl

addProbe, getProbe, getProbe, getProbes, removeProbe, removeProbe

Methods inherited from class com.samysadi.acs.core.notifications.NotifierImpl

addGlobalListener, addListener, cancelNotifications, cleanupListeners, disableNotifications, enableNotifications, getGlobalListeners, getListeners, isNotificationsDisabled, notify, notifyNow, removeAllGlobalListeners, removeAllListeners, removeAllListeners, removeGlobalListener, removeListener

Methods inherited from class java.lang.Object

equals, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.samysadi.acs.core.entity.Entity

addEntity, getConfig, getConfigRec, getEntities, getId, getLogger, getName, getProperties, getProperty, getProperty, hasParentRec, lockParent, lockParentRec, removeEntity, setConfig, setName, setProperty, unlockParent, unlockParentRec, unsetProperty

Methods inherited from interface com.samysadi.acs.core.notifications.Notifier

addGlobalListener, addListener, cancelNotifications, cleanupListeners, disableNotifications, enableNotifications, getGlobalListeners, getListeners, isNotificationsDisabled, notify, notifyNow, removeAllGlobalListeners, removeAllListeners, removeAllListeners, removeGlobalListener, removeListener

Methods inherited from interface com.samysadi.acs.core.tracing.Probed

addProbe, getProbe, getProbe, getProbes, removeProbe, removeProbe

Constructor Detail

VmPlacementPolicyAbstract

public VmPlacementPolicyAbstract()

Method Detail

clone

public VmPlacementPolicyAbstract clone()

Description copied from interface: Notifier

Creates a clone of this Notifier.

The clone will contain a new empty listeners list and is independent from this object.

Specified by:

clone in interface Entity

Specified by:

clone in interface Notifier

Specified by:

clone in interface VmPlacementPolicy

Overrides:

clone in class EntityImpl

getParent

public CloudProvider getParent()

Description copied from interface: Entity

Returns the parent of this entity, or null if no parent is set

Specified by:

getParent in interface Entity

Specified by:

getParent in interface VmPlacementPolicy

Overrides:

getParent in class EntityImpl

Returns:

the parent of this entity, or null

setParent

public void setParent(Entity parent)

Description copied from interface: Entity

Updates the parent of this entity.
This method makes sure that the old and the new parent keep their entities list updated, by automatically calling Entity.addEntity(Entity) and Entity.removeEntity(Entity).

A CoreNotificationCodes.ENTITY_PARENT_CHANGED notification is thrown.
Additionally, each descendant of this entity (ie: entities who have this entity as their direct or not direct parent) are notified using CoreNotificationCodes.ENTITY_ANCESTOR_CHANGED.

Specified by:

setParent in interface Entity

Overrides:

setParent in class EntityImpl

selectHost

public Host selectHost(VirtualMachine vm,
              List<Host> hosts,
              List<Host> excludedHosts)

Description copied from interface: VmPlacementPolicy

Selects a host where to place the given vm and returns it.

A host among all given hosts will be selected such that it satisfies the virtual machine's defined SLA (defined through its configuration).
Among other conditions, the selected host must be in FailureProneEntity.FailureState.OK state. But, it can be in a state other than PoweredEntity.PowerState.ON if the cloud provider's power manager allows it to be powered on. In which case, it is left to the placement method to power it on.

Depending on whether a host was found or not, a NotificationCodes.VMPLACEMENT_VMSELECTION_SUCCESS or NotificationCodes.VMPLACEMENT_VMSELECTION_FAILED is thrown.

Specified by:

selectHost in interface VmPlacementPolicy

hosts - possible hosts. May be null in which case, all hosts in the cloud are considered.

excludedHosts - a list of hosts that should not be selected. May be null.

Returns:

the selected host or null if no host was found

selectHost

public final Host selectHost(VirtualMachine vm,
              List<Host> hosts)

Description copied from interface: VmPlacementPolicy

Alias for VmPlacementPolicy.selectHost(VirtualMachine, List, List) where excluded hosts is null.

Specified by:

selectHost in interface VmPlacementPolicy

selectHost

public final Host selectHost(VirtualMachine vm)

Description copied from interface: VmPlacementPolicy

Alias for VmPlacementPolicy.selectHost(VirtualMachine, List) where possible hosts is null.

Specified by:

selectHost in interface VmPlacementPolicy

canPlaceVm

public boolean canPlaceVm(VirtualMachine vm,
                 Host host)

Description copied from interface: VmPlacementPolicy

Returns true if the vm can be placed on the given host.

Specified by:

canPlaceVm in interface VmPlacementPolicy

Returns:

true if the vm can be placed on the given host

placeVm

public void placeVm(VirtualMachine vm,
           Host host)

Description copied from interface: VmPlacementPolicy

Takes all actions in order to place the given vm on the given host. When all actions were taken, the VM's parent is updated.
You need to listen to the CoreNotificationCodes.ENTITY_PARENT_CHANGED to know when the placement has ended, as it may not be the case when this method returns.

During the placement, any needed resources (example: VirtualRam and/or VirtualStorage) are instantiated and set accordingly to the vm's SLA constraints (as defined in its configuration).

When the given vm already contains some or other resource, then implementations must use the already set resources and must not replace them.
If the already set resources cannot comply to the SLA constraints, then an exception is thrown.

The given host may be in another state than PoweredEntity.PowerState.ON. If so then this method asks the cloud provider's power manger to power it on.

You need to check for the return value of VmPlacementPolicy.canPlaceVm(VirtualMachine, Host) to see if the vm can be placed on the given host.
If you selected the host using VmPlacementPolicy.selectHost(VirtualMachine) then this method should succeed.

Specified by:

placeVm in interface VmPlacementPolicy

Parameters:

vm - the VirtualMachine to place

host - the Host where to place the vm

unplaceVm

public void unplaceVm(VirtualMachine vm)

Description copied from interface: VmPlacementPolicy

Takes all actions in order to unplaces the given vm.
When all actions were taken, the VM's parent is updated (set to null).

Any allocated resource during placement are detached from the parent host. This likely includes the VirtualRam and the VirtualStorage whose parents are then set to null.

The parent host of the VM should be powered off if the cloud provider's power manger allows it to.

Specified by:

unplaceVm in interface VmPlacementPolicy