com.hp.ov.sdk.rest.client

Class SwitchClientImpl

java.lang.Object

com.hp.ov.sdk.rest.client.SwitchClientImpl

All Implemented Interfaces:

SwitchClient

public class SwitchClientImpl
extends Object
implements SwitchClient

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SwitchClientImpl(HttpRestClient restClient, ResourceAdaptor adaptor, TaskMonitorManager taskMonitor)

Method Summary

Modifier and Type	Method and Description
TaskResourceV2	createSwitch(RestParams params, Switch switchObj, boolean aSync) This method aids in the creation of a switch.
TaskResourceV2	deleteSwitch(RestParams params, String resourceId, boolean aSync) This method aids in deletion of a switch.
SwitchCollection	getAllSwitches(RestParams params) This method aids in fetching the top of rack switches.
static SwitchClient	getClient()
String	getId(RestParams params, String name) The module aids in fetching the switch resource identifier for the switch name as specified in HPE OneView.
Switch	getSwitch(RestParams params, String resourceId) This method aids in fetching the switch for the given resource identifier.
Switch	getSwitchByName(RestParams params, String name) The module aids in fetching the switch details for the switch name as specified in HPE OneView.
EnvironmentalConfiguration	getSwitchEnvironmentalConfiguration(RestParams params, String resourceId) This method aids in fetching the environmental configuration for a switch.
SwitchPortStatistics	getSwitchPortStatistics(RestParams params, String resourceId, String portName) This method aids in fetching the statistics for the switch.
SwitchStatistics	getSwitchStatistics(RestParams params, String resourceId) This method aids in fetching the statistics for a switch.
TaskResourceV2	refreshSwitch(RestParams params, String resourceId, boolean aSync) This method aids in refreshing a switch.
TaskResourceV2	updateSwitch(RestParams params, String resourceId, Switch switchDto, boolean aSync) This method aids in updating a switch.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwitchClientImpl

protected SwitchClientImpl(HttpRestClient restClient,
                           ResourceAdaptor adaptor,
                           TaskMonitorManager taskMonitor)

Method Detail

getClient

public static SwitchClient getClient()

getSwitch

public Switch getSwitch(RestParams params,
                        String resourceId)

Description copied from interface: SwitchClient

This method aids in fetching the switch for the given resource identifier.

Specified by:

getSwitch in interface SwitchClient

Parameters:

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

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

Returns:

Switch containing the switch details.

getAllSwitches

public SwitchCollection getAllSwitches(RestParams params)

Description copied from interface: SwitchClient

This method aids in fetching the top of rack switches.

Specified by:

getAllSwitches in interface SwitchClient

Parameters:

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

Returns:

SwitchCollection containing the collection of switch details.

createSwitch

public TaskResourceV2 createSwitch(RestParams params,
                                   Switch switchObj,
                                   boolean aSync)

Description copied from interface: SwitchClient

This method aids in the creation of a switch.

Specified by:

createSwitch in interface SwitchClient

Parameters:

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

switchObj - Object containing the switch details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

updateSwitch

public TaskResourceV2 updateSwitch(RestParams params,
                                   String resourceId,
                                   Switch switchDto,
                                   boolean aSync)

Description copied from interface: SwitchClient

This method aids in updating a switch.

Specified by:

updateSwitch in interface SwitchClient

Parameters:

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

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

switchDto - Object containing the switch details.

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

deleteSwitch

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

Description copied from interface: SwitchClient

This method aids in deletion of a switch.

Specified by:

deleteSwitch in interface SwitchClient

Parameters:

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

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

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

refreshSwitch

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

Description copied from interface: SwitchClient

This method aids in refreshing a switch.

Specified by:

refreshSwitch in interface SwitchClient

Parameters:

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

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

aSync - flag to indicate whether the request should be processed asynchronously or synchronously.

Returns:

TaskResourceV2 containing the task status for the process.

getSwitchEnvironmentalConfiguration

public EnvironmentalConfiguration getSwitchEnvironmentalConfiguration(RestParams params,
                                                                      String resourceId)

Description copied from interface: SwitchClient

This method aids in fetching the environmental configuration for a switch.

Specified by:

getSwitchEnvironmentalConfiguration in interface SwitchClient

Parameters:

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

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

Returns:

EnvironmentalConfiguration containing the environment configuration for the switch.

getSwitchStatistics

public SwitchStatistics getSwitchStatistics(RestParams params,
                                            String resourceId)

Description copied from interface: SwitchClient

This method aids in fetching the statistics for a switch.

Specified by:

getSwitchStatistics in interface SwitchClient

Parameters:

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

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

Returns:

SwitchStatistics containing the statistics for the switch.

getSwitchPortStatistics

public SwitchPortStatistics getSwitchPortStatistics(RestParams params,
                                                    String resourceId,
                                                    String portName)

Description copied from interface: SwitchClient

This method aids in fetching the statistics for the switch.

Specified by:

getSwitchPortStatistics in interface SwitchClient

Parameters:

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

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

portName - The port name as seen in HPE OneView for which the statistics data should be retrieved.

Returns:

SwitchPortStatistics containing the statistics for a specific switch port.

getSwitchByName

public Switch getSwitchByName(RestParams params,
                              String name)

Description copied from interface: SwitchClient

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

Specified by:

getSwitchByName in interface SwitchClient

Parameters:

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

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

Returns:

Switch containing the switch details.

getId

public String getId(RestParams params,
                    String name)

Description copied from interface: SwitchClient

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

Specified by:

getId in interface SwitchClient

Parameters:

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

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

Returns:

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