com.abiquo.ssm.plugin

Interface Storage<C extends IConnection>

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, Pluggable

All Known Implementing Classes:

GenericISCSIPlugin

public interface Storage<C extends IConnection>
extends Pluggable

Defines an storage plugin that performs the operations in the target storage devices.

Author:

Ignasi Barrera

Method Summary

Modifier and Type	Method and Description
Volume	createVolume(C device, Pool pool, Volume volume) Creates a new volume.
void	deleteVolume(C device, Pool pool, java.lang.String uuid) Deletes the given volume.
Pool	getPool(C device, java.lang.String poolName) Get the information of the given pool.
Volume	getVolume(C device, Pool pool, java.lang.String uuid) Gets the information of the given volume.
Address	grantAccess(C device, Pool pool, java.lang.String volumeUuid, ClientDetails clientDetails) Allow the provided client to access the given volume.
java.util.List<Pool>	listPools(C device) Get all the pools defined in the given device.
java.util.List<Volume>	listVolumes(C device, Pool pool) Gets all the volumes in the given pool.
Volume	resizeVolume(C device, Pool pool, Volume volume) Updates an existing volume.
void	revokeAccess(C device, Pool pool, java.lang.String volumeUuid, ClientDetails clientDetails) Deny access for the provided client to the given volume.

Methods inherited from interface com.abiquo.commons.plugin.Pluggable

close, getConstraint, validateConfiguration

Method Detail

listPools

java.util.List<Pool> listPools(C device)
                        throws HypervisorPluginException

Get all the pools defined in the given device.

The storage pools are the containers for the volumes that will be created by Abiquo.

Parameters:

device - The storage device where to find the pools.

Returns:

The pools defined in the given device.

Throws:

HypervisorPluginException - If the pools can not be enumerated.

getPool

Pool getPool(C device,
             java.lang.String poolName)
      throws HypervisorPluginException

Get the information of the given pool.

The storage pools are the containers for the volumes that will be created by Abiquo.

Parameters:

device - The storage device where to find the pool.

poolName - The name of the pool to retrieve.

Returns:

The requested pool.

Throws:

HypervisorPluginException - If the requested pool cannot be retrieved.

listVolumes

java.util.List<Volume> listVolumes(C device,
                                   Pool pool)
                            throws HypervisorPluginException

Gets all the volumes in the given pool.

Volumes are block devices that will be attached to the virtual machines.

Parameters:

device - The device where the volumes are.

pool - The pool where the volumes are.

Returns:

The list of volumes in the pool.

Throws:

HypervisorPluginException - If the volumes can not be enumerated.

getVolume

Volume getVolume(C device,
                 Pool pool,
                 java.lang.String uuid)
          throws HypervisorPluginException

Gets the information of the given volume.

Volumes are block devices that will be attached to the virtual machines.

Parameters:

device - The device where the volumes is.

pool - The pool where the volume is.

uuid - The uuid of the volume to retrieve.

Returns:

The information of the given volume.

Throws:

HypervisorPluginException - If the requested volume can not be retrieved.

createVolume

Volume createVolume(C device,
                    Pool pool,
                    Volume volume)
             throws HypervisorPluginException

Creates a new volume.

Volumes are block devices that will be attached to the virtual machines.

Parameters:

device - The device where the volumes will be created.

pool - The pool where the volume will be created.

volume - The volume information.

Returns:

The information of the created volume.

Throws:

HypervisorPluginException - If the volume cannot be created.

deleteVolume

void deleteVolume(C device,
                  Pool pool,
                  java.lang.String uuid)
           throws HypervisorPluginException

Deletes the given volume.

Volumes are block devices that will be attached to the virtual machines.

Parameters:

device - The device where the volumes is.

pool - The pool where the volume is.

uuid - The uuid of the volume to delete.

Throws:

HypervisorPluginException - If the volume cannot be deleted.

resizeVolume

Volume resizeVolume(C device,
                    Pool pool,
                    Volume volume)
             throws HypervisorPluginException

Updates an existing volume.

Volumes are block devices that will be attached to the virtual machines.

Parameters:

device - The device where the volumes is.

pool - The pool where the volume is.

volume - The new volume information.

Returns:

The updated volume.

Throws:

HypervisorPluginException - If the volume cannot be modified.

grantAccess

Address grantAccess(C device,
                    Pool pool,
                    java.lang.String volumeUuid,
                    ClientDetails clientDetails)
             throws HypervisorPluginException

Allow the provided client to access the given volume.

This method is used to grant access to the given client to the volume identified by the given UUID.

Parameters:

device - The device where the volumes is.

pool - The pool where the volume is.

volumeUuid - The uuid of the volume.

clientDetails - The details of the client accessing the volume.

Returns:

The address where the provided client initiator can reach the volume.

Throws:

HypervisorPluginException - If the access to the volume cannot be granted.

revokeAccess

void revokeAccess(C device,
                  Pool pool,
                  java.lang.String volumeUuid,
                  ClientDetails clientDetails)
           throws HypervisorPluginException

Deny access for the provided client to the given volume.

This method is used to revoke access for the given iSCSI client.

Parameters:

device - The device where the volumes is.

pool - The pool where the volume is.

volumeUuid - The uuid of the volume.

clientDetails - The details of the client accessing the volume.

Throws:

HypervisorPluginException - If the access to the volume cannot be granted.