com.abiquo.ssm.plugin.iscsi

Class GenericISCSIPlugin

java.lang.Object

com.abiquo.ssm.plugin.iscsi.GenericISCSIPlugin

All Implemented Interfaces:

Pluggable, Storage<Device>, Closeable, AutoCloseable

@PluginMetadata(type="GENERIC_ISCSI",
                friendlyName="generic iSCSI storage",
                version="4.0.0",
                supportedVersions="4.0.0")
public class GenericISCSIPlugin
extends Object
implements Storage<Device>

Simulates a Storage plugin to provide generic iSCSI storage functionallity.

This plugin cannot not be used to create or manage volumes. It is only present to provide the common storage behavior for the generic iSCSI feature.

Volumes will be manually created in the target storage pool and Abiquo will only assign them to the mock pool that is returned by the plugin.

Author:

Ignasi Barrera

Field Summary

Fields

Modifier and Type	Field and Description
static String	MOCK_POOL_NAME
static String	PLUGIN_TYPE
static Long	POOL_SIZE

Constructor Summary

Constructors

Constructor and Description
GenericISCSIPlugin()

Method Summary

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

Methods inherited from class java.lang.Object

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

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

close

Field Detail

PLUGIN_TYPE

public static final String PLUGIN_TYPE

See Also:

Constant Field Values

MOCK_POOL_NAME

public static String MOCK_POOL_NAME

POOL_SIZE

public static final Long POOL_SIZE

Constructor Detail

GenericISCSIPlugin

public GenericISCSIPlugin()

Method Detail

getConstraint

public String getConstraint(String key)

Specified by:

getConstraint in interface Pluggable

validateConfiguration

public void validateConfiguration()
                           throws IllegalStateException

Specified by:

validateConfiguration in interface Pluggable

Throws:

IllegalStateException

getPool

public Pool getPool(Device device,
                    String poolName)
             throws HypervisorPluginException

Description copied from interface: Storage

Get the information of the given pool.

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

Specified by:

getPool in interface Storage<Device>

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.

listPools

public List<Pool> listPools(Device device)
                     throws HypervisorPluginException

Description copied from interface: Storage

Get all the pools defined in the given device.

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

Specified by:

listPools in interface Storage<Device>

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.

createVolume

@UnsupportedOperation
public Volume createVolume(Device device,
                                                 Pool pool,
                                                 Volume volume)
                                          throws HypervisorPluginException

Description copied from interface: Storage

Creates a new volume.

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

Specified by:

createVolume in interface Storage<Device>

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.

resizeVolume

@UnsupportedOperation
public Volume resizeVolume(Device device,
                                                 Pool pool,
                                                 Volume volume)
                                          throws HypervisorPluginException

Description copied from interface: Storage

Updates an existing volume.

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

Specified by:

resizeVolume in interface Storage<Device>

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.

deleteVolume

@UnsupportedOperation
public void deleteVolume(Device device,
                                               Pool pool,
                                               String uuid)
                                        throws HypervisorPluginException

Description copied from interface: Storage

Deletes the given volume.

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

Specified by:

deleteVolume in interface Storage<Device>

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.

listVolumes

@UnsupportedOperation
public List<Volume> listVolumes(Device device,
                                                      Pool pool)
                                               throws HypervisorPluginException

Description copied from interface: Storage

Gets all the volumes in the given pool.

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

Specified by:

listVolumes in interface Storage<Device>

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

@UnsupportedOperation
public Volume getVolume(Device device,
                                              Pool pool,
                                              String uuid)
                                       throws HypervisorPluginException

Description copied from interface: Storage

Gets the information of the given volume.

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

Specified by:

getVolume in interface Storage<Device>

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.

grantAccess

@UnsupportedOperation
public Address grantAccess(Device device,
                                                 Pool pool,
                                                 String volumeUuid,
                                                 ClientDetails clientDetails)
                                          throws HypervisorPluginException

Description copied from interface: Storage

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.

Specified by:

grantAccess in interface Storage<Device>

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

@UnsupportedOperation
public void revokeAccess(Device device,
                                               Pool pool,
                                               String volumeUuid,
                                               ClientDetails clientDetails)
                                        throws HypervisorPluginException

Description copied from interface: Storage

Deny access for the provided client to the given volume.

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

Specified by:

revokeAccess in interface Storage<Device>

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.