org.openstack4j.openstack.storage.block.internal

Class BlockVolumeServiceImpl

java.lang.Object

org.openstack4j.openstack.internal.BaseOpenStackService

org.openstack4j.openstack.storage.block.internal.BaseBlockStorageServices

org.openstack4j.openstack.storage.block.internal.BlockVolumeServiceImpl

All Implemented Interfaces:

BlockVolumeService, RestService

public class BlockVolumeServiceImpl
extends BaseBlockStorageServices
implements BlockVolumeService

Manages Volumes and Volume Type based operations against Block Storage (Cinder)

Author:

Jeremy Unruh

Nested Class Summary

Nested classes/interfaces inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

BaseOpenStackService.Invocation<R>

Constructor Summary

Constructors

Constructor and Description
BlockVolumeServiceImpl()

Method Summary

Modifier and Type	Method and Description
Volume	create(Volume volume) Creates a new Block Storage Volume
VolumeType	createVolumeType(VolumeType volumeType) Creates a new volume type with the specified name
ActionResponse	delete(String volumeId) Deletes the specified volume
void	deleteVolumeType(String volumeTypeId) Deletes the specified VolumeType
ActionResponse	extend(String volumeId, Integer newSize) Extends the specified volume size.
ActionResponse	forceDelete(String volumeId) Attempt forced removal of volume, regardless of the state.
Volume	get(String volumeId) Gets a Block Storage volume by ID
List<? extends Volume>	list() Lists summary information for all Block Storage volumes that the tenant who submits the request can access.
List<? extends Volume>	list(Map<String,String> filteringParams) Returns list of Block Storage volumes filtered by parameters.
List<? extends VolumeType>	listVolumeTypes() The volume type defines the characteristics of a volume
ActionResponse	migrate(String volumeId, String hostService, boolean forceHostCopy) migrate a volume to another host and service
ActionResponse	readOnlyModeUpdate(String volumeId, boolean readonly) Updates volume read-only access-mode flag
ActionResponse	resetState(String volumeId, Volume.Status status) Resets the specified volume status.
BlockVolumeTransferService	transfer() Returns the API used to transfer a Volume from one tenant/project to another
ActionResponse	update(String volumeId, String name, String description) OpenStack only allows name or description to be updated.
VolumeUploadImage	uploadToImage(String volumeId, UploadImageData data) Uploads a volume to the image service

Methods inherited from class org.openstack4j.openstack.internal.BaseOpenStackService

delete, deleteWithResponse, get, getProvider, getServiceVersion, getXOpenstackRequestId, head, patch, patchWithResponse, post, postWithResponse, put, request, toList, uri

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockVolumeServiceImpl

public BlockVolumeServiceImpl()

Method Detail

listVolumeTypes

public List<? extends VolumeType> listVolumeTypes()

The volume type defines the characteristics of a volume

Specified by:

listVolumeTypes in interface BlockVolumeService

Returns:

List of VolumeType entities

list

public List<? extends Volume> list()

Lists summary information for all Block Storage volumes that the tenant who submits the request can access.

Specified by:

list in interface BlockVolumeService

Returns:

List of Volumes

list

public List<? extends Volume> list(Map<String,String> filteringParams)

Returns list of Block Storage volumes filtered by parameters.

Specified by:

list in interface BlockVolumeService

Parameters:

filteringParams - map (name, value) of filtering parameters

Returns:

get

public Volume get(String volumeId)

Gets a Block Storage volume by ID

Specified by:

get in interface BlockVolumeService

Parameters:

volumeId - the volume identifier

Returns:

the volume or null if not found

delete

public ActionResponse delete(String volumeId)

Deletes the specified volume

Specified by:

delete in interface BlockVolumeService

Parameters:

volumeId - the volume identifier

Returns:

the action response

forceDelete

public ActionResponse forceDelete(String volumeId)

Attempt forced removal of volume, regardless of the state. It's dangerous but useful. It's not 100% success.

Specified by:

forceDelete in interface BlockVolumeService

Parameters:

volumeId - the volume id

Returns:

the action response

resetState

public ActionResponse resetState(String volumeId,
                                 Volume.Status status)

Resets the specified volume status.

Specified by:

resetState in interface BlockVolumeService

Parameters:

volumeId - the volume id

status - new volume status

Returns:

the action response

extend

public ActionResponse extend(String volumeId,
                             Integer newSize)

Extends the specified volume size.

Specified by:

extend in interface BlockVolumeService

Parameters:

volumeId - the volume id

newSize - new volume size

Returns:

the action response

create

public Volume create(Volume volume)

Creates a new Block Storage Volume

Specified by:

create in interface BlockVolumeService

Parameters:

volume - the volume for create

Returns:

the created volume

update

public ActionResponse update(String volumeId,
                             String name,
                             String description)

OpenStack only allows name or description to be updated. This call enforces that based on the API docs.

Specified by:

update in interface BlockVolumeService

Parameters:

volumeId - the volume id

name - the name to update (null indicates no name update)

description - the description to update (null indicates no description update)

Returns:

the action response

deleteVolumeType

public void deleteVolumeType(String volumeTypeId)

Deletes the specified VolumeType

Specified by:

deleteVolumeType in interface BlockVolumeService

Parameters:

volumeTypeId - the volume type identifier

createVolumeType

public VolumeType createVolumeType(VolumeType volumeType)

Creates a new volume type with the specified name

Specified by:

createVolumeType in interface BlockVolumeService

Parameters:

volumeType - the volumeType for create

Returns:

the created volume type

migrate

public ActionResponse migrate(String volumeId,
                              String hostService,
                              boolean forceHostCopy)

Description copied from interface: BlockVolumeService

migrate a volume to another host and service

Specified by:

migrate in interface BlockVolumeService

Parameters:

volumeId - the volume id

hostService - the destination host and service ,like kvmnode002021.cnsuning.com@lvmdriver

Returns:

the action response

uploadToImage

public VolumeUploadImage uploadToImage(String volumeId,
                                       UploadImageData data)

Description copied from interface: BlockVolumeService

Uploads a volume to the image service

Specified by:

uploadToImage in interface BlockVolumeService

Parameters:

volumeId - the volume identifier to upload

data - the data about the volume being uploaded (required)

Returns:

the volume upload image containing the current status

transfer

public BlockVolumeTransferService transfer()

Description copied from interface: BlockVolumeService

Returns the API used to transfer a Volume from one tenant/project to another

Specified by:

transfer in interface BlockVolumeService

Returns:

the volume transfer service

readOnlyModeUpdate

public ActionResponse readOnlyModeUpdate(String volumeId,
                                         boolean readonly)

Updates volume read-only access-mode flag

Specified by:

readOnlyModeUpdate in interface BlockVolumeService

Parameters:

volumeId - ID of volume to update

readonly - enables or disables update of volume to read-only access mode

Returns:

the action response