com.hp.ov.sdk.rest.client

Class FcNetworkClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.FcNetworkClientImpl

All Implemented Interfaces:

FcNetworkClient

public class FcNetworkClientImpl
extends Object
implements FcNetworkClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FcNetworkClientImpl(FcNetworkAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createFcNetwork(RestParams params, FcNetwork fcNetworkDto, boolean aSync, boolean useJsonRequest) The module aids in creation of an FC network when provided with the FC network details as an FcNetwork object or JsonRequest.
TaskResourceV2	deleteFcNetwork(RestParams params, String resourceId, boolean aSync) The module aids in deleting an FC network for the specified FC network resource identifier.
FcNetworkCollection	getAllFcNetworks(RestParams params) The module aids in fetching the FC network details for all FC network registered under the current HPE OneView.
static FcNetworkClient	getClient()
FcNetwork	getFcNetwork(RestParams params, String resourceId) The module aids in fetching the FC network details for the specified FC network resource identifier.
FcNetworkCollection	getFcNetworkByFilter(RestParams params, Integer start, Integer count) The module aids in fetching the FC network details, where start and count values are specified to fetch the number of FC networks.
FcNetwork	getFcNetworkByName(RestParams params, String name) The module aids in fetching the FC network details for the specified FC network name.
String	getId(RestParams params, String name) The module aids in fetching the FC network resource identifier for the FC network name as specified in HPE OneView.
TaskResourceV2	updateFcNetwork(RestParams params, String resourceId, FcNetwork fcNetworkDto, boolean aSync, boolean useJsonRequest) The module takes in an FcNetwork object or JsonRequest and updates the existing FC network 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

FcNetworkClientImpl

protected FcNetworkClientImpl(FcNetworkAdaptor adaptor,
                              TaskAdaptor taskAdaptor,
                              TaskMonitorManager taskMonitor)

Method Detail

getClient

public static FcNetworkClient getClient()

getFcNetwork

public FcNetwork getFcNetwork(RestParams params,
                              String resourceId)

Description copied from interface: FcNetworkClient

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

Specified by:

getFcNetwork in interface FcNetworkClient

Parameters:

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

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

Returns:

FcNetwork containing the FC network details.

getFcNetworkByFilter

public FcNetworkCollection getFcNetworkByFilter(RestParams params,
                                                Integer start,
                                                Integer count)

Description copied from interface: FcNetworkClient

The module aids in fetching the FC network details, where start and count values are specified to fetch the number of FC networks.

Specified by:

getFcNetworkByFilter in interface FcNetworkClient

Parameters:

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

start - Integer value specifying the start count.

count - Integer value specifying the number of FC network fetched at once.

Returns:

FcNetworkCollection containing a collection of FC network details.

getAllFcNetworks

public FcNetworkCollection getAllFcNetworks(RestParams params)

Description copied from interface: FcNetworkClient

The module aids in fetching the FC network details for all FC network registered under the current HPE OneView.

Specified by:

getAllFcNetworks in interface FcNetworkClient

Parameters:

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

Returns:

FcNetworkCollection containing a collection of FC network details.

getFcNetworkByName

public FcNetwork getFcNetworkByName(RestParams params,
                                    String name)

Description copied from interface: FcNetworkClient

The module aids in fetching the FC network details for the specified FC network name.

Specified by:

getFcNetworkByName in interface FcNetworkClient

Parameters:

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

name - The resourceName is the FC network name as seen in HPE OneView.

Returns:

FcNetwork containing the FC network details.

createFcNetwork

public TaskResourceV2 createFcNetwork(RestParams params,
                                      FcNetwork fcNetworkDto,
                                      boolean aSync,
                                      boolean useJsonRequest)

Description copied from interface: FcNetworkClient

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

Specified by:

createFcNetwork in interface FcNetworkClient

Parameters:

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

fcNetworkDto - This is a object containing the FC network details, used to create FC network.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

updateFcNetwork

public TaskResourceV2 updateFcNetwork(RestParams params,
                                      String resourceId,
                                      FcNetwork fcNetworkDto,
                                      boolean aSync,
                                      boolean useJsonRequest)

Description copied from interface: FcNetworkClient

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

Specified by:

updateFcNetwork in interface FcNetworkClient

Parameters:

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

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

fcNetworkDto - This is a object containing the update to be made to existing FC network pointed to by the above mentioned resource identifier.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteFcNetwork

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

Description copied from interface: FcNetworkClient

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

Specified by:

deleteFcNetwork in interface FcNetworkClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: FcNetworkClient

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

Specified by:

getId in interface FcNetworkClient

Parameters:

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

name - The name is the FC network name as seen in HPE OneView.

Returns:

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