com.hp.ov.sdk.rest.client

Class EnclosureGroupClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.EnclosureGroupClientImpl

All Implemented Interfaces:

EnclosureGroupClient

public class EnclosureGroupClientImpl
extends Object
implements EnclosureGroupClient

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnclosureGroupClientImpl(EnclosureGroupAdaptor adaptor, TaskAdaptor taskAdaptor)

Method Summary

Modifier and Type	Method and Description
EnclosureGroups	createEnclosureGroup(RestParams params, EnclosureGroups dto, boolean useJsonRequest) The module aids in the creation of an enclosure group when provided with the enclosure group details as EnclosureGroups object or JsonRequest.
String	deleteEnclosureGroup(RestParams params, String resourceId) The module aids in deleting an enclosure group for the specified enclosure group resource identifier.
EnclosureGroupCollectionV2	getAllEnclosureGroups(RestParams params) The module aids in fetching the enclosure group details for all enclosure groups registered under the current HPE OneView.
static EnclosureGroupClient	getClient()
String	getConfigurationScript(RestParams params, String resourceId) The module aids in fetching the configuration script for the specified enclosure group resource identifier.
EnclosureGroups	getEnclosureGroup(RestParams params, String resourceId) The module aids in fetching the enclosure group details for the specified enclosure group resource identifier.
EnclosureGroups	getEnclosureGroupByName(RestParams params, String name) The module aids in fetching the enclosure group details for the specified enclosure group name.
String	getId(RestParams params, String name) The module aids in fetching the enclosure group resource identifier for the enclosure group name as specified in HPE OneView.
String	updateConfigurationScript(RestParams params, String resourceId, String scriptData) The module aids in updating the configuration script for the specified enclosure group resource identifier.
EnclosureGroups	updateEnclosureGroup(RestParams params, String resourceId, EnclosureGroups enclosureGroupDto, boolean useJsonRequest) The module takes in an EnclosureGroups object or JsonRequest and updates the existing enclosure group based on resource identifier.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

public static final org.slf4j.Logger LOGGER

Constructor Detail

EnclosureGroupClientImpl

protected EnclosureGroupClientImpl(EnclosureGroupAdaptor adaptor,
                                   TaskAdaptor taskAdaptor)

Method Detail

getClient

public static EnclosureGroupClient getClient()

getEnclosureGroup

public EnclosureGroups getEnclosureGroup(RestParams params,
                                         String resourceId)

Description copied from interface: EnclosureGroupClient

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

Specified by:

getEnclosureGroup in interface EnclosureGroupClient

Parameters:

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

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

Returns:

EnclosureGroups containing the enclosure group details.

getAllEnclosureGroups

public EnclosureGroupCollectionV2 getAllEnclosureGroups(RestParams params)

Description copied from interface: EnclosureGroupClient

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

Specified by:

getAllEnclosureGroups in interface EnclosureGroupClient

Parameters:

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

Returns:

EnclosureGroupCollectionV2 containing a collection of enclosure group details.

getEnclosureGroupByName

public EnclosureGroups getEnclosureGroupByName(RestParams params,
                                               String name)

Description copied from interface: EnclosureGroupClient

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

Specified by:

getEnclosureGroupByName in interface EnclosureGroupClient

Parameters:

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

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

Returns:

EnclosureGroups containing the enclosure group details.

createEnclosureGroup

public EnclosureGroups createEnclosureGroup(RestParams params,
                                            EnclosureGroups dto,
                                            boolean useJsonRequest)

Description copied from interface: EnclosureGroupClient

The module aids in the creation of an enclosure group when provided with the enclosure group details as EnclosureGroups object or JsonRequest.

Specified by:

createEnclosureGroup in interface EnclosureGroupClient

Parameters:

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

dto - This is an object containing the enclosure group details, used to create an enclosure group.

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

Returns:

EnclosureGroups containing the enclosure group details.

updateEnclosureGroup

public EnclosureGroups updateEnclosureGroup(RestParams params,
                                            String resourceId,
                                            EnclosureGroups enclosureGroupDto,
                                            boolean useJsonRequest)

Description copied from interface: EnclosureGroupClient

The module takes in an EnclosureGroups object or JsonRequest and updates the existing enclosure group based on resource identifier.

Specified by:

updateEnclosureGroup in interface EnclosureGroupClient

Parameters:

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

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

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

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

Returns:

EnclosureGroups containing the enclosure group details.

deleteEnclosureGroup

public String deleteEnclosureGroup(RestParams params,
                                   String resourceId)

Description copied from interface: EnclosureGroupClient

The module aids in deleting an enclosure group for the specified enclosure group resource identifier.

Specified by:

deleteEnclosureGroup in interface EnclosureGroupClient

Parameters:

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

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

Returns:

an empty String on successful deletion. Otherwise, returns an error message.

getConfigurationScript

public String getConfigurationScript(RestParams params,
                                     String resourceId)

Description copied from interface: EnclosureGroupClient

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

Specified by:

getConfigurationScript in interface EnclosureGroupClient

Parameters:

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

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

Returns:

the configuration script for the specified enclosure group.

updateConfigurationScript

public String updateConfigurationScript(RestParams params,
                                        String resourceId,
                                        String scriptData)

Description copied from interface: EnclosureGroupClient

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

Specified by:

updateConfigurationScript in interface EnclosureGroupClient

Parameters:

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

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

scriptData - THe script data to be updated for enclosure group.

Returns:

the configuration script for the specified enclosure group.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: EnclosureGroupClient

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

Specified by:

getId in interface EnclosureGroupClient

Parameters:

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

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

Returns:

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