com.samysadi.acs.hardware.storage

Class VirtualStorageDynamic

java.lang.Object

com.samysadi.acs.core.notifications.NotifierImpl

com.samysadi.acs.core.tracing.ProbedImpl

com.samysadi.acs.core.entity.EntityImpl

com.samysadi.acs.core.entity.FailureProneEntityImpl

com.samysadi.acs.hardware.misc.MemoryUnitImpl<Zone>

com.samysadi.acs.hardware.misc.VirtualMemoryUnitImpl<Zone,Unit>

com.samysadi.acs.hardware.misc.VirtualMemoryUnitDynamic<StorageFile,Storage>

com.samysadi.acs.hardware.storage.VirtualStorageDynamic

All Implemented Interfaces:

AllocatableEntity, Entity, FailureProneEntity, Notifier, Probed, MemoryUnit<StorageFile>, MemoryZone, VirtualMemoryUnit<StorageFile,Storage>, Storage, StorageFile, VirtualStorage, Cloneable

public class VirtualStorageDynamic
extends VirtualMemoryUnitDynamic<StorageFile,Storage>
implements VirtualStorage

Since:

1.0

See Also:

VirtualMemoryUnitDynamic

Nested Class Summary

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

NotifierImpl.NotifyEvent

Nested classes/interfaces inherited from interface com.samysadi.acs.core.entity.FailureProneEntity

FailureProneEntity.FailureState

Nested classes/interfaces inherited from interface com.samysadi.acs.hardware.storage.StorageFile

StorageFile.StorageFileShareMode

Constructor Summary

Constructors

Constructor and Description
VirtualStorageDynamic() Empty constructor that creates a storage with zero capacity.
VirtualStorageDynamic(long capacity)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAppend() Returns true if an append operation can run now on this file.
boolean	canRead() Returns true if a read operation can run now on this file.
boolean	canWrite() Returns true if a write operation can run now on this file.
VirtualStorageDynamic	clone() Creates a clone of this Notifier.
void	dealWithOperationActivation(StorageOperation operation) This method is called by a StorageOperation when it is started.
void	dealWithOperationDeactivation(StorageOperation operation, long oldCompletedLength) This method is called by a StorageOperation when it is stopped.
SfPlacementPolicy	getPlacementPolicy() Returns the SfPlacementPolicy that was used when placing this StorageFile in the current storage.
StorageFile.StorageFileShareMode	getShareMode() Returns the StorageFile.StorageFileShareMode of this file.
List<StorageFile>	getStorageFiles() Alias for MemoryUnit.getMemoryZones().
StorageProvisioner	getStorageProvisioner() Returns the StorageProvisioner.
User	getUser() Returns the User that owns this StorageFile.
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	setPlacementPolicy(SfPlacementPolicy policy) This method is called by SfPlacementPolicy when placing this StorageFile on a storage.
void	setShareMode(StorageFile.StorageFileShareMode shareMode) Updates the StorageFile.StorageFileShareMode of this file.
void	setUser(User user) Updates the User that owns this StorageFile.
void	unplace() Unplaces current StorageFile using current set SfPlacementPolicy, or sets a null parent for current VM if no SfPlacementPolicy was set. In both situations, this method guarantees that the current StorageFile's parent will be set to null.

Methods inherited from class com.samysadi.acs.hardware.misc.VirtualMemoryUnitDynamic

allocate, free, getSize

Methods inherited from class com.samysadi.acs.hardware.misc.VirtualMemoryUnitImpl

getMemoryMap, getMetaData, getParent, getParentHost, getRealFreeCapacity, isAllocated, isCapacityReserved, isReplicaOf, modify, removeMemoryMap, setAllocated, setCapacity, setIsCapacityReserved, setMetaData, setSize, supportsFailureStateUpdate

Methods inherited from class com.samysadi.acs.hardware.misc.MemoryUnitImpl

addEntity, findReplica, getCapacity, getEntities, getFreeCapacity, getMemoryZones, removeEntity

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

getFailureState, setFailureState

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

getConfig, getConfigRec, getId, getLogger, getName, getNextId, getProperties, getProperty, getProperty, hashCode, hasParentRec, lockParent, lockParentRec, 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.hardware.storage.VirtualStorage

getParent

Methods inherited from interface com.samysadi.acs.hardware.misc.VirtualMemoryUnit

getRealFreeCapacity, isCapacityReserved, setIsCapacityReserved

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

isAllocated, setAllocated

Methods inherited from interface com.samysadi.acs.hardware.misc.MemoryUnit

allocate, findReplica, free, getCapacity, getFreeCapacity, getMemoryZones, getParentHost, setCapacity

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

getFailureState, setFailureState, supportsFailureStateUpdate

Methods inherited from interface com.samysadi.acs.hardware.misc.MemoryZone

getMemoryMap, getMetaData, getSize, isReplicaOf, modify, removeMemoryMap, setMetaData, setSize

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

VirtualStorageDynamic

public VirtualStorageDynamic()

Empty constructor that creates a storage with zero capacity.

This constructor is provided only to satisfy the Entity contract.
You should use VirtualStorageDynamic(long) though.

VirtualStorageDynamic

public VirtualStorageDynamic(long capacity)

Method Detail

clone

public VirtualStorageDynamic 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 FailureProneEntity

Specified by:

clone in interface Notifier

Specified by:

clone in interface MemoryUnit<StorageFile>

Specified by:

clone in interface MemoryZone

Specified by:

clone in interface VirtualMemoryUnit<StorageFile,Storage>

Specified by:

clone in interface Storage

Specified by:

clone in interface StorageFile

Specified by:

clone in interface VirtualStorage

Overrides:

clone in class VirtualMemoryUnitDynamic<StorageFile,Storage>

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

getStorageFiles

public final List<StorageFile> getStorageFiles()

Description copied from interface: Storage

Alias for MemoryUnit.getMemoryZones().

Specified by:

getStorageFiles in interface Storage

getStorageProvisioner

public StorageProvisioner getStorageProvisioner()

Description copied from interface: Storage

Returns the StorageProvisioner.

Specified by:

getStorageProvisioner in interface Storage

Returns:

the StorageProvisioner

getShareMode

public StorageFile.StorageFileShareMode getShareMode()

Description copied from interface: StorageFile

Returns the StorageFile.StorageFileShareMode of this file.

Specified by:

getShareMode in interface StorageFile

Returns:

the StorageFile.StorageFileShareMode of this file

setShareMode

public void setShareMode(StorageFile.StorageFileShareMode shareMode)

Description copied from interface: StorageFile

Updates the StorageFile.StorageFileShareMode of this file.

Specified by:

setShareMode in interface StorageFile

canAppend

public boolean canAppend()

Description copied from interface: StorageFile

Returns true if an append operation can run now on this file.

Specified by:

canAppend in interface StorageFile

Returns:

true if an append operation can run now on this file

canWrite

public boolean canWrite()

Description copied from interface: StorageFile

Returns true if a write operation can run now on this file.

Specified by:

canWrite in interface StorageFile

Returns:

true if a write operation can run now on this file

canRead

public boolean canRead()

Description copied from interface: StorageFile

Returns true if a read operation can run now on this file.

Specified by:

canRead in interface StorageFile

Returns:

true if a read operation can run now on this file

dealWithOperationActivation

public void dealWithOperationActivation(StorageOperation operation)

Description copied from interface: StorageFile

This method is called by a StorageOperation when it is started.

Specified by:

dealWithOperationActivation in interface StorageFile

dealWithOperationDeactivation

public void dealWithOperationDeactivation(StorageOperation operation,
                                 long oldCompletedLength)

Description copied from interface: StorageFile

This method is called by a StorageOperation when it is stopped.

Specified by:

dealWithOperationDeactivation in interface StorageFile

oldCompletedLength - the completed length before this operation is started. This can be used to compute newly completed length during current run (using operation.getCompletedLength() - oldCompletedLength).

getPlacementPolicy

public SfPlacementPolicy getPlacementPolicy()

Description copied from interface: StorageFile

Returns the SfPlacementPolicy that was used when placing this StorageFile in the current storage. null is returned if this StorageFile has no defined SfPlacementPolicy.

Specified by:

getPlacementPolicy in interface StorageFile

Returns:

the SfPlacementPolicy that was used when placing this StorageFile or null

setPlacementPolicy

public void setPlacementPolicy(SfPlacementPolicy policy)

Description copied from interface: StorageFile

This method is called by SfPlacementPolicy when placing this StorageFile on a storage.

You should not need to call this method if you are not implementing a placement policy.

Specified by:

setPlacementPolicy in interface StorageFile

unplace

public void unplace()

Description copied from interface: StorageFile

Unplaces current StorageFile using current set SfPlacementPolicy, or sets a null parent for current VM if no SfPlacementPolicy was set.
In both situations, this method guarantees that the current StorageFile's parent will be set to null. Because this may take time, you need to listen to CoreNotificationCodes.ENTITY_PARENT_CHANGED to know when all actions have been taken.

If you only want to set a null parent for this StorageFile then use Entity.setParent(Entity). Which will set the null parent immediately.

Specified by:

unplace in interface StorageFile

getUser

public User getUser()

Description copied from interface: StorageFile

Returns the User that owns this StorageFile.

Specified by:

getUser in interface StorageFile

Returns:

the User that owns this StorageFile

setUser

public void setUser(User user)

Description copied from interface: StorageFile

Updates the User that owns this StorageFile.

Specified by:

setUser in interface StorageFile