com.hp.ov.sdk.rest.client

Class StorageVolumeClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.StorageVolumeClientImpl

All Implemented Interfaces:

StorageVolumeClient

public class StorageVolumeClientImpl
extends Object
implements StorageVolumeClient

Field Summary

Fields inherited from interface com.hp.ov.sdk.rest.client.StorageVolumeClient

REPAIR_FILTER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StorageVolumeClientImpl(HttpRestClient restClient, ResourceAdaptor resourceAdaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createStorageVolume(RestParams params, AddStorageVolumeV2 addStorageVolumeDto, boolean aSync, boolean useJsonRequest) The module aids in creation of storage volume when provided with the storage volume details as an AddStorageVolume object or JsonRequest.
TaskResourceV2	createStorageVolumeSnapshot(RestParams params, String storageVolumeId, StorageVolumeSnapshot snapshot, boolean aSync) Creates a snapshot for the storage volume specified by the resource identifier.
TaskResourceV2	deleteStorageVolume(RestParams params, String resourceId, boolean aSync) The module aids in deleting a storage volume for the specified storage volume resource identifier.
TaskResourceV2	deleteStorageVolumeSnapshot(RestParams params, String storageVolumeId, String snapshotId, boolean aSync) Removes a storage volume snapshot from HPE OneView and storage system.
StorageVolumeCollection	getAllStorageVolumes(RestParams params) The module aids in fetching the storage volume details for all the storage volumes found under the current HPE OneView.
StorageVolumeSnapshotCollection	getAllStorageVolumeSnapshots(RestParams params, String storageVolumeId) Returns all the snapshots available of an existing storage volume.
AttachableStorageVolumeCollection	getAttachableVolumes(RestParams params) This method aids in fetching the attachable volumes that are connected to the specified networks based on the storage system port's expected network connectivity.
static StorageVolumeClient	getClient()
ExtraStorageVolumeCollection	getExtraManagedStorageVolumePaths(RestParams params) Returns the list of extra managed storage volume paths.
String	getId(RestParams params, String name) The module aids in fetching the storage volume resource identifier for the storage volume name as specified in HPE OneView.
StorageVolumeV2	getStorageVolume(RestParams params, String resourceId) The module aids in fetching the storage volume details for the specified storage volume resource identifier.
StorageVolumeV2	getStorageVolumeByName(RestParams params, String name) The module aids in fetching the storage volume details for the storage volume name as specified in HPE OneView.
StorageVolumeSnapshot	getStorageVolumeSnapshot(RestParams params, String storageVolumeId, String snapshotId) Returns a snapshot of a storage volume.
TaskResourceV2	repairExtraManagedStorageVolumePath(RestParams params, ExtraStorageVolumeRepair repair, boolean aSync) Removes extra presentations from a specified storage volume on the storage system.
String	updateStorageVolume(RestParams params, String resourceId, StorageVolumeV2 storageVolumeDto, boolean useJsonRequest) The module takes in an StorageVolumeV2 object or JsonRequest and updates the existing storage volume based on the resource identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageVolumeClientImpl

protected StorageVolumeClientImpl(HttpRestClient restClient,
                                  ResourceAdaptor resourceAdaptor,
                                  TaskAdaptor taskAdaptor,
                                  TaskMonitorManager taskMonitor)

Method Detail

getClient

public static StorageVolumeClient getClient()

getStorageVolume

public StorageVolumeV2 getStorageVolume(RestParams params,
                                        String resourceId)

Description copied from interface: StorageVolumeClient

The module aids in fetching the storage volume details for the specified storage volume resource identifier.

Specified by:

getStorageVolume in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage volume as seen in HPE OneView.

Returns:

StorageVolumeV2 containing the storage volume details.

getAllStorageVolumes

public StorageVolumeCollection getAllStorageVolumes(RestParams params)

Description copied from interface: StorageVolumeClient

The module aids in fetching the storage volume details for all the storage volumes found under the current HPE OneView.

Specified by:

getAllStorageVolumes in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

StorageVolumeCollection containing a collection of storage volume details.

getStorageVolumeByName

public StorageVolumeV2 getStorageVolumeByName(RestParams params,
                                              String name)

Description copied from interface: StorageVolumeClient

The module aids in fetching the storage volume details for the storage volume name as specified in HPE OneView.

Specified by:

getStorageVolumeByName in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

name - The name is the storage volume name as seen in HPE OneView.

Returns:

StorageVolumeV2 containing the storage volume details.

createStorageVolume

public TaskResourceV2 createStorageVolume(RestParams params,
                                          AddStorageVolumeV2 addStorageVolumeDto,
                                          boolean aSync,
                                          boolean useJsonRequest)

Description copied from interface: StorageVolumeClient

The module aids in creation of storage volume when provided with the storage volume details as an AddStorageVolume object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

createStorageVolume in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

addStorageVolumeDto - Object containing the storage volume details, used to create a storage volume.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of AddStorageVolumeV2 object which takes in a String containing new storage volume details, which is converted to a StorageVolume object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateStorageVolume

public String updateStorageVolume(RestParams params,
                                  String resourceId,
                                  StorageVolumeV2 storageVolumeDto,
                                  boolean useJsonRequest)

Description copied from interface: StorageVolumeClient

The module takes in an StorageVolumeV2 object or JsonRequest and updates the existing storage volume based on the resource identifier.

Specified by:

updateStorageVolume in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage volume as seen in HPE OneView.

storageVolumeDto - Object containing the storage volume details, used to update a storage volume.

useJsonRequest - The JsonRequest body is part of StorageVolumeV2 object which takes in a String containing the update to be made, which is converted to StorageVolumeV2 object using an adaptor and processed.

Returns:

String Updated if successful.

deleteStorageVolume

public TaskResourceV2 deleteStorageVolume(RestParams params,
                                          String resourceId,
                                          boolean aSync)

Description copied from interface: StorageVolumeClient

The module aids in deleting a storage volume for the specified storage volume resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

deleteStorageVolume in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

resourceId - The resource identifier for storage volume as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getAttachableVolumes

public AttachableStorageVolumeCollection getAttachableVolumes(RestParams params)

Description copied from interface: StorageVolumeClient

This method aids in fetching the attachable volumes that are connected to the specified networks based on the storage system port's expected network connectivity.

Specified by:

getAttachableVolumes in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

Returns:

AttachableStorageVolumeCollection containing the attached storage volume details.

getStorageVolumeSnapshot

public StorageVolumeSnapshot getStorageVolumeSnapshot(RestParams params,
                                                      String storageVolumeId,
                                                      String snapshotId)

Description copied from interface: StorageVolumeClient

Returns a snapshot of a storage volume.

Specified by:

getStorageVolumeSnapshot in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

storageVolumeId - resource identifier for a storage volume as seen in HPE OneView.

snapshotId - resource identifier for the snapshot of the storage volume.

Returns:

StorageVolumeSnapshot or null in case the parameter snapshotId does not match any existing storage volume snapshot.

getAllStorageVolumeSnapshots

public StorageVolumeSnapshotCollection getAllStorageVolumeSnapshots(RestParams params,
                                                                    String storageVolumeId)

Description copied from interface: StorageVolumeClient

Returns all the snapshots available of an existing storage volume.

Specified by:

getAllStorageVolumeSnapshots in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

storageVolumeId - resource identifier for the storage volume as seen in HPE OneView.

Returns:

StorageVolumeSnapshotCollection containing all snapshots for the storage volume.

createStorageVolumeSnapshot

public TaskResourceV2 createStorageVolumeSnapshot(RestParams params,
                                                  String storageVolumeId,
                                                  StorageVolumeSnapshot snapshot,
                                                  boolean aSync)

Description copied from interface: StorageVolumeClient

Creates a snapshot for the storage volume specified by the resource identifier.

Specified by:

createStorageVolumeSnapshot in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

storageVolumeId - resource identifier for a storage volume as seen in HPE OneView.

snapshot - StorageVolumeSnapshot object containing the data to be used during the snapshot creation.

aSync - flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

deleteStorageVolumeSnapshot

public TaskResourceV2 deleteStorageVolumeSnapshot(RestParams params,
                                                  String storageVolumeId,
                                                  String snapshotId,
                                                  boolean aSync)

Description copied from interface: StorageVolumeClient

Removes a storage volume snapshot from HPE OneView and storage system.

Specified by:

deleteStorageVolumeSnapshot in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

storageVolumeId - resource identifier for a storage volume as seen in HPE OneView.

snapshotId - resource identifier for the snapshot of the storage volume.

aSync - flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

getExtraManagedStorageVolumePaths

public ExtraStorageVolumeCollection getExtraManagedStorageVolumePaths(RestParams params)

Description copied from interface: StorageVolumeClient

Returns the list of extra managed storage volume paths.

Specified by:

getExtraManagedStorageVolumePaths in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

Returns:

ExtraStorageVolumeCollection containing the resources found.

repairExtraManagedStorageVolumePath

public TaskResourceV2 repairExtraManagedStorageVolumePath(RestParams params,
                                                          ExtraStorageVolumeRepair repair,
                                                          boolean aSync)

Description copied from interface: StorageVolumeClient

Removes extra presentations from a specified storage volume on the storage system.

Specified by:

repairExtraManagedStorageVolumePath in interface StorageVolumeClient

Parameters:

params - structure containing the connection details.

repair - information about the extra paths to delete.

aSync - flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 which returns the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: StorageVolumeClient

The module aids in fetching the storage volume resource identifier for the storage volume name as specified in HPE OneView.

Specified by:

getId in interface StorageVolumeClient

Parameters:

params - The RestParams is a structure containing the connection details.

name - The name is the storage volume name as seen in HPE OneView.

Returns:

String which is the resource identifier for the storage volume name as seen in HPE OneView.