com.hp.ov.sdk.rest.client

Class LogicalEnclosureClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.LogicalEnclosureClientImpl

All Implemented Interfaces:

LogicalEnclosureClient

public class LogicalEnclosureClientImpl
extends Object
implements LogicalEnclosureClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogicalEnclosureClientImpl(LogicalEnclosureAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createLogicalEnclosure(RestParams params, AddLogicalEnclosure addLogicalEnclosureDto, boolean aSync, boolean useJsonRequest) The module aids in creation of logical enclosure when provided with the logical enclosure details as AddEnclosure object or JsonRequest.
TaskResourceV2	createSupportDump(RestParams params, SupportDump supportDumpDto, String resourceId, boolean aSync, boolean useJsonRequest) The module aids in creation of a support dump for the logical enclosure with the specified resource identifier.
TaskResourceV2	deleteLogicalEnclosure(RestParams params, String resourceId, boolean aSync) The module aids in deleting a logical enclosure for the specified logical enclosure resource identifier.
LogicalEnclosureList	getAllLogicalEnclosures(RestParams params) The module aids in fetching the logical enclosure details for all logical enclosures registered under the current HPE OneView.
static LogicalEnclosureClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the logical enclosure resource identifier for the logical enclosure name as specified in HPE OneView.
LogicalEnclosure	getLogicalEnclosure(RestParams params, String resourceId) The module aids in fetching the logical enclosure details for the specified logical enclosure resource identifier.
LogicalEnclosure	getLogicalEnclosureByName(RestParams params, String name) The module aids in fetching the logical enclosure details for the specified logical enclosure name.
String	getScript(RestParams params, String resourceId) The module aids in fetching the configuration script for the specified logical enclosure resource identifier.
TaskResourceV2	patchLogicalEnclosure(RestParams params, String resourceId, Patch patchDto, boolean aSync, boolean useJsonRequest) The module takes in a Patch object or JsonRequest and updates the existing logical enclosure based on the resource identifier and the content of the Patch object.
TaskResourceV2	updateConfiguration(RestParams params, String resourceId, boolean aSync) This method aids in reapplying the logical enclosure configuration.
TaskResourceV2	updateFromGroup(RestParams params, String resourceId, boolean aSync) This method aids in updating the logical enclosure to be consistent with the enclosure group when the logical enclosure is in an inconsistent state.
TaskResourceV2	updateLogicalEnclosure(RestParams params, String resourceId, LogicalEnclosure logicalEnclosureDto, boolean aSync, boolean useJsonRequest) The module takes in an LogicalEnclosure object or JsonRequest and updates the existing logical enclosure based on resource identifier.
TaskResourceV2	updateScript(RestParams params, String resourceId, String scriptData, boolean aSync) The module aids in updating the configuration script for the specified logical enclosure resource identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalEnclosureClientImpl

protected LogicalEnclosureClientImpl(LogicalEnclosureAdaptor adaptor,
                                     TaskAdaptor taskAdaptor,
                                     TaskMonitorManager taskMonitor)

Method Detail

getClient

public static LogicalEnclosureClient getClient()

getLogicalEnclosure

public LogicalEnclosure getLogicalEnclosure(RestParams params,
                                            String resourceId)

Description copied from interface: LogicalEnclosureClient

The module aids in fetching the logical enclosure details for the specified logical enclosure resource identifier.

Specified by:

getLogicalEnclosure in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

Returns:

LogicalEnclosure containing the logical enclosure details.

getAllLogicalEnclosures

public LogicalEnclosureList getAllLogicalEnclosures(RestParams params)

Description copied from interface: LogicalEnclosureClient

The module aids in fetching the logical enclosure details for all logical enclosures registered under the current HPE OneView.

Specified by:

getAllLogicalEnclosures in interface LogicalEnclosureClient

Parameters:

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

Returns:

LogicalEnclosureList containing the collection of logical enclosures.

getLogicalEnclosureByName

public LogicalEnclosure getLogicalEnclosureByName(RestParams params,
                                                  String name)

Description copied from interface: LogicalEnclosureClient

The module aids in fetching the logical enclosure details for the specified logical enclosure name.

Specified by:

getLogicalEnclosureByName in interface LogicalEnclosureClient

Parameters:

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

name - The name is the logical enclosure name as seen in HPE OneView.

Returns:

LogicalEnclosure containing the logical enclosure details.

createLogicalEnclosure

public TaskResourceV2 createLogicalEnclosure(RestParams params,
                                             AddLogicalEnclosure addLogicalEnclosureDto,
                                             boolean aSync,
                                             boolean useJsonRequest)

Description copied from interface: LogicalEnclosureClient

The module aids in creation of logical enclosure when provided with the logical enclosure details as AddEnclosure object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

createLogicalEnclosure in interface LogicalEnclosureClient

Parameters:

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

addLogicalEnclosureDto - The connection details to fetch logical enclosure.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of AddLogicalEnclosure object which takes in a String containing the new logical enclosure details, which is converted to AddLogicalEnclosure object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

updateLogicalEnclosure

public TaskResourceV2 updateLogicalEnclosure(RestParams params,
                                             String resourceId,
                                             LogicalEnclosure logicalEnclosureDto,
                                             boolean aSync,
                                             boolean useJsonRequest)

Description copied from interface: LogicalEnclosureClient

The module takes in an LogicalEnclosure object or JsonRequest and updates the existing logical enclosure based on resource identifier. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

updateLogicalEnclosure in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

logicalEnclosureDto - This is a object containing the update to be made to existing logical enclosure pointed to by the above mentioned resource identifier

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

patchLogicalEnclosure

public TaskResourceV2 patchLogicalEnclosure(RestParams params,
                                            String resourceId,
                                            Patch patchDto,
                                            boolean aSync,
                                            boolean useJsonRequest)

Description copied from interface: LogicalEnclosureClient

The module takes in a Patch object or JsonRequest and updates the existing logical enclosure based on the resource identifier and the content of the Patch object. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

patchLogicalEnclosure in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

patchDto - This is a object containing the update to be made to existing logical enclosure pointed to by the above mentioned resource identifier

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteLogicalEnclosure

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

Description copied from interface: LogicalEnclosureClient

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

Specified by:

deleteLogicalEnclosure in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateFromGroup

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

Description copied from interface: LogicalEnclosureClient

This method aids in updating the logical enclosure to be consistent with the enclosure group when the logical enclosure is in an inconsistent state.

Specified by:

updateFromGroup in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateConfiguration

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

Description copied from interface: LogicalEnclosureClient

This method aids in reapplying the logical enclosure configuration.

Specified by:

updateConfiguration in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getScript

public String getScript(RestParams params,
                        String resourceId)

Description copied from interface: LogicalEnclosureClient

The module aids in fetching the configuration script for the specified logical enclosure resource identifier.

Specified by:

getScript in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

Returns:

the configuration script for the specified enclosure.

updateScript

public TaskResourceV2 updateScript(RestParams params,
                                   String resourceId,
                                   String scriptData,
                                   boolean aSync)

Description copied from interface: LogicalEnclosureClient

The module aids in updating the configuration script for the specified logical enclosure resource identifier.

Specified by:

updateScript in interface LogicalEnclosureClient

Parameters:

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

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

scriptData - The script data to be updated for logical enclosure.

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

createSupportDump

public TaskResourceV2 createSupportDump(RestParams params,
                                        SupportDump supportDumpDto,
                                        String resourceId,
                                        boolean aSync,
                                        boolean useJsonRequest)

Description copied from interface: LogicalEnclosureClient

The module aids in creation of a support dump for the logical enclosure with the specified resource identifier. A logical enclosure support dump includes content for logical interconnects associated with that logical enclosure. By default, it also contains appliance support dump content. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

createSupportDump in interface LogicalEnclosureClient

Parameters:

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

supportDumpDto - The details to create the support dump.

resourceId - The resource identifier for logical enclosure as seen in HPE OneView.

aSync - Flag input to process request asynchronously or synchronously.

useJsonRequest - The JsonRequest body is part of SupportDump object which takes in a String containing the support dump details, which is converted to SupportDump object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: LogicalEnclosureClient

The module aids in fetching the logical enclosure resource identifier for the logical enclosure name as specified in HPE OneView.

Specified by:

getId in interface LogicalEnclosureClient

Parameters:

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

name - The name is the logical enclosure name as seen in HPE OneView.

Returns:

String which is the resource identifier for the logical enclosure name as seen in HPE OneView.