com.samysadi.acs.hardware.storage

Interface StorageFile

All Superinterfaces:

Cloneable, Entity, MemoryZone, Notifier, Probed

All Known Subinterfaces:

VirtualStorage

All Known Implementing Classes:

StorageFileDefault, VirtualStorageDynamic, VirtualStorageElastic, VirtualStorageFixedSize

public interface StorageFile
extends MemoryZone

Contains methods that defines a file stored on a Storage.

All implementation classes should provide a constructor with one argument of long type that specifies the StorageFile's size.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StorageFile.StorageFileShareMode

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.
StorageFile	clone() Creates a clone of this entity and sets its parent to null.
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.
Storage	getParent() Returns the parent of this entity, or null if no parent is set
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.
User	getUser() Returns the User that owns this StorageFile.
void	setPlacementPolicy(SfPlacementPolicy policy) This method is called by SfPlacementPolicy when placing this StorageFile on a storage.
void	setShareMode(StorageFile.StorageFileShareMode newShareMode) 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 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, setParent, 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

Method Detail

clone

StorageFile clone()

Description copied from interface: Entity

Creates a clone of this entity and sets its parent to null.

This is a deep clone method which also clones almost all children entities and sets their parents to the newly created clone. The only children which are not cloned are those implementing the UncloneableEntity interface.

Implementations must ensure that the new clone will be independent from the current entity.

Specified by:

clone in interface Entity

Specified by:

clone in interface MemoryZone

Specified by:

clone in interface Notifier

getParent

Storage 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 MemoryZone

Returns:

the parent of this entity, or null

getShareMode

StorageFile.StorageFileShareMode getShareMode()

Returns the StorageFile.StorageFileShareMode of this file.

Returns:

the StorageFile.StorageFileShareMode of this file

setShareMode

void setShareMode(StorageFile.StorageFileShareMode newShareMode)

Updates the StorageFile.StorageFileShareMode of this file.

canAppend

boolean canAppend()

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

Returns:

true if an append operation can run now on this file

canWrite

boolean canWrite()

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

Returns:

true if a write operation can run now on this file

canRead

boolean canRead()

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

Returns:

true if a read operation can run now on this file

dealWithOperationActivation

void dealWithOperationActivation(StorageOperation operation)

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

Parameters:

operation -

dealWithOperationDeactivation

void dealWithOperationDeactivation(StorageOperation operation,
                                 long oldCompletedLength)

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

Parameters:

operation -

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

SfPlacementPolicy getPlacementPolicy()

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

Returns:

the SfPlacementPolicy that was used when placing this StorageFile or null

setPlacementPolicy

void setPlacementPolicy(SfPlacementPolicy policy)

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.

Parameters:

policy -

unplace

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. 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.

getUser

User getUser()

Returns the User that owns this StorageFile.

Returns:

the User that owns this StorageFile

setUser

void setUser(User user)

Updates the User that owns this StorageFile.

Parameters:

user -