com.hp.ov.sdk.rest.client

Class NetworkClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.NetworkClientImpl

All Implemented Interfaces:

NetworkClient

public class NetworkClientImpl
extends Object
implements NetworkClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NetworkClientImpl(HttpRestClient restClient, ConnectionTemplateClient connectionTemplateClient, NetworkAdaptor adaptor, TaskAdaptor taskAdaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createNetwork(RestParams params, Network dto, boolean aSync, boolean useJsonRequest) The module aids in creation of an ethernet network when provided with the ethernet network details as a Network object or JsonRequest.
TaskResourceV2	createNetworkInBulk(RestParams params, BulkEthernetNetwork bulkEthernetDto, boolean aSync, boolean useJsonRequest) The module aids in creation of set of ethernet networks when provided with the ethernet network details as a BulkEthernetNetwork object or a JsonRequest containing a VLAN identifier range.
TaskResourceV2	deleteNetwork(RestParams params, String resourceId, boolean aSync) The module aids in deleting a ethernet network for the specified ethernet network resource identifier.
NetworkCollection	getAllNetworks(RestParams params) The module aids in fetching the ethernet network details for all the ethernet networks found under the current HPE OneView.
static NetworkClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the ethernet network resource identifier for the ethernet network name as specified in HPE OneView.
Network	getNetwork(RestParams params, String resourceId) The module aids in fetching the Network details for the specified ethernet network resource identifier.
List<String>	getNetworkAssociatedProfiles(RestParams params, String resourceId) Returns a list of profile URIs for the ethernet network.
List<String>	getNetworkAssociatedUplinkGroups(RestParams params, String resourceId) Returns the uplink sets which are using an ethernet network.
Network	getNetworkByName(RestParams params, String name) The module aids in fetching the ethernet network details for the ethernet network name as specified in HPE OneView.
TaskResourceV2	updateNetwork(RestParams params, String resourceId, Network dto, boolean asyncOrSyncMode, boolean useJsonRequest) The module takes in a Network object or JsonRequest and updates the existing ethernet 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

NetworkClientImpl

protected NetworkClientImpl(HttpRestClient restClient,
                            ConnectionTemplateClient connectionTemplateClient,
                            NetworkAdaptor adaptor,
                            TaskAdaptor taskAdaptor,
                            TaskMonitorManager taskMonitor)

Method Detail

getClient

public static NetworkClient getClient()

getNetwork

public Network getNetwork(RestParams params,
                          String resourceId)

Description copied from interface: NetworkClient

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

Specified by:

getNetwork in interface NetworkClient

Parameters:

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

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

Returns:

Network containing the ethernet network details.

getAllNetworks

public NetworkCollection getAllNetworks(RestParams params)

Description copied from interface: NetworkClient

The module aids in fetching the ethernet network details for all the ethernet networks found under the current HPE OneView.

Specified by:

getAllNetworks in interface NetworkClient

Parameters:

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

Returns:

NetworkCollection containing the collection of ethernet network details.

getNetworkByName

public Network getNetworkByName(RestParams params,
                                String name)

Description copied from interface: NetworkClient

The module aids in fetching the ethernet network details for the ethernet network name as specified in HPE OneView.

Specified by:

getNetworkByName in interface NetworkClient

Parameters:

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

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

Returns:

Network containing the ethernet network details.

createNetwork

public TaskResourceV2 createNetwork(RestParams params,
                                    Network dto,
                                    boolean aSync,
                                    boolean useJsonRequest)

Description copied from interface: NetworkClient

The module aids in creation of an ethernet network when provided with the ethernet network details as a Network object or JsonRequest. It can process the request asynchronously or synchronously, based on the flag input. ATTENTION: if you use async mode equals to true and you set some connection template data, this information will not be used. Thus, we strongly recommend the value false for the async flag if you want to set bandwidth values.

Specified by:

createNetwork in interface NetworkClient

Parameters:

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

dto - This is a object containing the ethernet network details, used to create a ethernet network.

aSync - Flag input to process request asynchronously or synchronously (preferable false).

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

Returns:

TaskResourceV2 containing the task status for the process.

updateNetwork

public TaskResourceV2 updateNetwork(RestParams params,
                                    String resourceId,
                                    Network dto,
                                    boolean asyncOrSyncMode,
                                    boolean useJsonRequest)

Description copied from interface: NetworkClient

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

Specified by:

updateNetwork in interface NetworkClient

Parameters:

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

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

dto - This is a object containing the ethernet network details, used to update a ethernet network

asyncOrSyncMode - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

deleteNetwork

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

Description copied from interface: NetworkClient

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

Specified by:

deleteNetwork in interface NetworkClient

Parameters:

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

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

aSync - Flag input to process request asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

createNetworkInBulk

public TaskResourceV2 createNetworkInBulk(RestParams params,
                                          BulkEthernetNetwork bulkEthernetDto,
                                          boolean aSync,
                                          boolean useJsonRequest)

Description copied from interface: NetworkClient

The module aids in creation of set of ethernet networks when provided with the ethernet network details as a BulkEthernetNetwork object or a JsonRequest containing a VLAN identifier range. It can process the request asynchronously or synchronously, based on the flag input.

Specified by:

createNetworkInBulk in interface NetworkClient

Parameters:

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

bulkEthernetDto - This is a object containing the BulkEthernetNetwork details, used to create a set of ethernet networks for the mentioned range with VLAN name as suffix.

aSync - Flag input to process request asynchronously or synchronously.

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

Returns:

TaskResourceV2 containing the task status for the process.

getNetworkAssociatedProfiles

public List<String> getNetworkAssociatedProfiles(RestParams params,
                                                 String resourceId)

Description copied from interface: NetworkClient

Returns a list of profile URIs for the ethernet network.

Specified by:

getNetworkAssociatedProfiles in interface NetworkClient

Parameters:

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

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

Returns:

list of profile URIs for the specified ethernet network.

getNetworkAssociatedUplinkGroups

public List<String> getNetworkAssociatedUplinkGroups(RestParams params,
                                                     String resourceId)

Description copied from interface: NetworkClient

Returns the uplink sets which are using an ethernet network.

Specified by:

getNetworkAssociatedUplinkGroups in interface NetworkClient

Parameters:

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

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

Returns:

list of uplink sets using the specified ethernet network.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: NetworkClient

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

Specified by:

getId in interface NetworkClient

Parameters:

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

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

Returns:

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