com.hp.ov.sdk.rest.client

Class EnclosureClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.EnclosureClientImpl

All Implemented Interfaces:

EnclosureClient

public class EnclosureClientImpl
extends Object
implements EnclosureClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnclosureClientImpl(EnclosureAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createEnclosure(RestParams params, AddEnclosureV2 enclosureDto, boolean aSync, boolean useJsonRequest) The module aids in the creation of an enclosure when provided with the enclosure details as an AddEnclosure object or JsonRequest.
TaskResourceV2	deleteEnclosure(RestParams params, String resourceId, boolean aSync) The module aids in deleting an enclosure for the specified enclosure resource identifier.
SsoUrlData	getActiveOaSsoUrl(RestParams params, String resourceId) This method aids in fetching data that can be used to construct a single sign-on URL for an Onboard Administrator.
EnclosureCollectionV2	getAllEnclosures(RestParams params) The module aids in fetching the enclosure details for all enclosures registered under the current HPE OneView.
static EnclosureClient	getClient()
Enclosures	getEnclosure(RestParams params, String resourceId) The module aids in fetching the enclosure details for the specified enclosure resource identifier.
Enclosures	getEnclosureByName(RestParams params, String name) The module aids in fetching the enclosure details for the specified enclosure name.
EnvironmentalConfiguration	getEnvironmentalConfiguration(RestParams params, String resourceId) This method aids in fetching the environmental configuration of the enclosure identified by the given enclosure identifier.
String	getId(RestParams params, String name) The module aids in fetching the enclosure resource identifier for the enclosure name as specified in HPE OneView.
String	getScript(RestParams params, String resourceId) The module aids in fetching the configuration script for the specified enclosure resource identifier.
SsoUrlData	getStandbyOaSsoUrl(RestParams params, String resourceId) This method aids in fetching data that can be used to construct a single sign-on URL for an onboard administrator.
UtilizationData	getUtilization(RestParams params, String resourceId) This method aids in retrieving historical utilization data for the specified enclosure.
TaskResourceV2	patchEnclosure(RestParams params, String resourceId, Patch patchDto, boolean aSync) The module takes in a Patch object or JsonRequest and updates the existing enclosure based on the resource identifier and the content of the Patch object.
TaskResourceV2	updateCompliance(RestParams params, String resourceId, boolean aSync) This method aids in updating the enclosure configuration with that of the enclosure group script.
TaskResourceV2	updateConfiguration(RestParams params, String resourceId, boolean aSync) This method aids in reapplying the enclosure configuration.
TaskResourceV2	updateEnclosure(RestParams params, String resourceId, Enclosures enclosureDto, boolean aSync, boolean useJsonRequest) The module takes in an enclosure object or JsonRequest and updates the existing enclosure based on the resource identifier.
TaskResourceV2	updateEnclosureFwBaseline(RestParams params, String resourceId, FwBaselineConfig fwBaselineConfigDto, boolean aSync) This method aids in applying the firmware baseline to the enclosure.
EnvironmentalConfiguration	updateEnvironmentalConfiguration(RestParams params, String resourceId, EnvironmentalConfigurationUpdate environmentalConfigurationUpdateDto) This method aids in updating the environmental configuration of the enclosure resource identifier.
TaskResourceV2	updateRefreshState(RestParams params, String resourceId, RefreshStateConfig refreshStateConfigDto, boolean aSync) This method aids in refreshing the enclosure to fix configuration issues.
TaskResourceV2	updateScript(RestParams params, String resourceId, String scriptData, boolean aSync, boolean useJsonRequest) The module aids in updating the configuration script for the specified enclosure resource identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnclosureClientImpl

protected EnclosureClientImpl(EnclosureAdaptor adaptor,
                              TaskAdaptor taskAdaptor,
                              TaskMonitorManager taskMonitor)

Method Detail

getClient

public static EnclosureClient getClient()

getEnclosure

public Enclosures getEnclosure(RestParams params,
                               String resourceId)

Description copied from interface: EnclosureClient

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

Specified by:

getEnclosure in interface EnclosureClient

Parameters:

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

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

Returns:

Enclosures containing the enclosure details.

getAllEnclosures

public EnclosureCollectionV2 getAllEnclosures(RestParams params)

Description copied from interface: EnclosureClient

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

Specified by:

getAllEnclosures in interface EnclosureClient

Parameters:

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

Returns:

enclosureCollectionDto which is a object containing the collection of enclosure.

getEnclosureByName

public Enclosures getEnclosureByName(RestParams params,
                                     String name)

Description copied from interface: EnclosureClient

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

Specified by:

getEnclosureByName in interface EnclosureClient

Parameters:

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

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

Returns:

Enclosures containing the enclosure details.

createEnclosure

public TaskResourceV2 createEnclosure(RestParams params,
                                      AddEnclosureV2 enclosureDto,
                                      boolean aSync,
                                      boolean useJsonRequest)

Description copied from interface: EnclosureClient

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

Specified by:

createEnclosure in interface EnclosureClient

Parameters:

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

enclosureDto - The enclosure information that should be created.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

updateEnclosure

public TaskResourceV2 updateEnclosure(RestParams params,
                                      String resourceId,
                                      Enclosures enclosureDto,
                                      boolean aSync,
                                      boolean useJsonRequest)

Description copied from interface: EnclosureClient

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

Specified by:

updateEnclosure in interface EnclosureClient

Parameters:

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

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

enclosureDto - This is a object containing the update to be made to existing 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 Enclosures object which takes in a String containing the update to be made, which is converted to Enclosure object using adaptor and processed.

Returns:

TaskResourceV2 containing the task status for the process.

patchEnclosure

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

Description copied from interface: EnclosureClient

The module takes in a Patch object or JsonRequest and updates the existing 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:

patchEnclosure in interface EnclosureClient

Parameters:

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

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteEnclosure

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

Description copied from interface: EnclosureClient

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

Specified by:

deleteEnclosure in interface EnclosureClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getActiveOaSsoUrl

public SsoUrlData getActiveOaSsoUrl(RestParams params,
                                    String resourceId)

Description copied from interface: EnclosureClient

This method aids in fetching data that can be used to construct a single sign-on URL for an Onboard Administrator.

Specified by:

getActiveOaSsoUrl in interface EnclosureClient

Parameters:

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

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

Returns:

SsoUrlData, gets the data used for single sign URL for onboard administrator.

updateCompliance

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

Description copied from interface: EnclosureClient

This method aids in updating the enclosure configuration with that of the enclosure group script. This is not applicable if the enclosure is monitored.

Specified by:

updateCompliance in interface EnclosureClient

Parameters:

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

resourceId - The resource identifier for 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: EnclosureClient

This method aids in reapplying the enclosure configuration.

Specified by:

updateConfiguration in interface EnclosureClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateEnclosureFwBaseline

public TaskResourceV2 updateEnclosureFwBaseline(RestParams params,
                                                String resourceId,
                                                FwBaselineConfig fwBaselineConfigDto,
                                                boolean aSync)

Description copied from interface: EnclosureClient

This method aids in applying the firmware baseline to the enclosure. This method can be used to update the OA firmware, or the OA, logical interconnect, and server profiles in the enclosure. This is not applicable if enclosure is monitored.

Specified by:

updateEnclosureFwBaseline in interface EnclosureClient

Parameters:

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

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

fwBaselineConfigDto - fwBaselineConfig is the firmware baseline to be applied to the enclosure

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getEnvironmentalConfiguration

public EnvironmentalConfiguration getEnvironmentalConfiguration(RestParams params,
                                                                String resourceId)

Description copied from interface: EnclosureClient

This method aids in fetching the environmental configuration of the enclosure identified by the given enclosure identifier.

Specified by:

getEnvironmentalConfiguration in interface EnclosureClient

Parameters:

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

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

Returns:

EnvironmentalConfiguration of the enclosure resource.

updateEnvironmentalConfiguration

public EnvironmentalConfiguration updateEnvironmentalConfiguration(RestParams params,
                                                                   String resourceId,
                                                                   EnvironmentalConfigurationUpdate environmentalConfigurationUpdateDto)

Description copied from interface: EnclosureClient

This method aids in updating the environmental configuration of the enclosure resource identifier.

Specified by:

updateEnvironmentalConfiguration in interface EnclosureClient

Parameters:

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

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

environmentalConfigurationUpdateDto - environmentalConfiguration, environmental configuration of enclosure resource specifying the cpu, power value.

Returns:

EnvironmentalConfiguration of the enclosure resource.

updateRefreshState

public TaskResourceV2 updateRefreshState(RestParams params,
                                         String resourceId,
                                         RefreshStateConfig refreshStateConfigDto,
                                         boolean aSync)

Description copied from interface: EnclosureClient

This method aids in refreshing the enclosure to fix configuration issues.

Specified by:

updateRefreshState in interface EnclosureClient

Parameters:

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

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

refreshStateConfigDto - refreshStateConfigDto, RefreshStateConfig containing the refresh state details to fix configuration issues.

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: EnclosureClient

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

Specified by:

getScript in interface EnclosureClient

Parameters:

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

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

Returns:

String, the configuration script for the specified enclosure.

updateScript

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

Description copied from interface: EnclosureClient

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

Specified by:

updateScript in interface EnclosureClient

Parameters:

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

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

scriptData - The script data to be updated for enclosure.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

getStandbyOaSsoUrl

public SsoUrlData getStandbyOaSsoUrl(RestParams params,
                                     String resourceId)

Description copied from interface: EnclosureClient

This method aids in fetching data that can be used to construct a single sign-on URL for an onboard administrator.

Specified by:

getStandbyOaSsoUrl in interface EnclosureClient

Parameters:

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

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

Returns:

SsoUrlData containing the data used for single sign URL for onboard administrator.

getUtilization

public UtilizationData getUtilization(RestParams params,
                                      String resourceId)

Description copied from interface: EnclosureClient

This method aids in retrieving historical utilization data for the specified enclosure.

Specified by:

getUtilization in interface EnclosureClient

Parameters:

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

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

Returns:

UtilizationData containing resource data utilization such as power, cpu.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: EnclosureClient

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

Specified by:

getId in interface EnclosureClient

Parameters:

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

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

Returns:

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